Fix role docs section levels (#367)

* Fix role docs section levels. * Collection links should stay as before, so they do not show up in TOC, same as for plugins.
ansible-community · Dec 29, 2024 · f931674 · f931674
1 parent 1003bcb
commit f931674
Show file tree

Hide file tree

Showing 13 changed files with 24 additions and 21 deletions.
diff --git a/changelogs/fragments/367-role-headings.yml b/changelogs/fragments/367-role-headings.yml
@@ -0,0 +1,3 @@
+bugfixes:
+  - "Fix role section heading levels. Examples and attributes should be below role entrypoints
+    (https://github.com/ansible-community/antsibull-docs/issues/366, https://github.com/ansible-community/antsibull-docs/pull/367)."
diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2
@@ -144,7 +144,7 @@ Parameters
 {%   if ep_doc['attributes'] %}
 
 Attributes
-----------
+^^^^^^^^^^
 
 @{     attributes_rst(ep_doc['attributes'], attribute_html_prefix=entry_point ~ '--', role_entrypoint=entry_point) }@
 {%   endif %}
@@ -194,7 +194,7 @@ See Also
 
 {%   if ep_doc['examples'] and ep_doc['examples'] | trim -%}
 Examples
---------
+^^^^^^^^
 
 .. code-block:: @{ ep_doc['examples_format'] | rst_format(for_sphinx=true) }@
 

diff --git a/src/antsibull_docs/data/docsite/simplified-rst/role.rst.j2 b/src/antsibull_docs/data/docsite/simplified-rst/role.rst.j2
@@ -103,7 +103,7 @@ Parameters
 {%   if ep_doc['attributes'] %}
 
 Attributes
-----------
+^^^^^^^^^^
 
 @{     attributes_rst(ep_doc['attributes'], role_entrypoint=entry_point) }@
 {%   endif %}
@@ -152,7 +152,7 @@ See Also
 
 {%   if ep_doc['examples'] and ep_doc['examples'] | trim -%}
 Examples
---------
+^^^^^^^^
 
 .. code-block:: @{ ep_doc['examples_format'] | rst_format }@
 

diff --git a/tests/functional/baseline-default/collections/ns/col2/bar_role.rst b/tests/functional/baseline-default/collections/ns/col2/bar_role.rst
@@ -68,7 +68,7 @@ Synopsis
 
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml+jinja
 

diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_role.rst b/tests/functional/baseline-default/collections/ns2/col/foo_role.rst
@@ -170,7 +170,7 @@ Parameters
 
 
 Attributes
-----------
+^^^^^^^^^^
 
 .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
 
@@ -283,7 +283,7 @@ See Also
        The official documentation on the **ns2.col.foo** module.
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml+jinja
 

diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/bar_role.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/bar_role.rst
@@ -68,7 +68,7 @@ Synopsis
 
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml+jinja
 

diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_role.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_role.rst
@@ -170,7 +170,7 @@ Parameters
 
 
 Attributes
-----------
+^^^^^^^^^^
 
 .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
 
@@ -283,7 +283,7 @@ See Also
        The official documentation on the **ns2.col.foo** module.
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml+jinja
 

diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_role.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_role.rst
@@ -167,7 +167,7 @@ Parameters
 
 
 Attributes
-----------
+^^^^^^^^^^
 
 .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
 
@@ -280,7 +280,7 @@ See Also
        The official documentation on the **ns2.col.foo** module.
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml+jinja
 

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_role.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_role.rst
@@ -89,7 +89,7 @@ Parameters
 
 
 Attributes
-----------
+^^^^^^^^^^
 
 .. list-table::
   :widths: auto
@@ -134,7 +134,7 @@ See Also
   The official documentation on the **ns2.col.foo** module.
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml
 

diff --git a/tests/functional/baseline-simplified-rst/collections/ns/col2/bar_role.rst b/tests/functional/baseline-simplified-rst/collections/ns/col2/bar_role.rst
@@ -33,7 +33,7 @@ Synopsis
 
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml
 

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_role.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_role.rst
@@ -89,7 +89,7 @@ Parameters
 
 
 Attributes
-----------
+^^^^^^^^^^
 
 .. list-table::
   :widths: auto
@@ -134,7 +134,7 @@ See Also
   The official documentation on the **ns2.col.foo** module.
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml
 

diff --git a/tests/functional/baseline-squash-hierarchy/foo_role.rst b/tests/functional/baseline-squash-hierarchy/foo_role.rst
@@ -170,7 +170,7 @@ Parameters
 
 
 Attributes
-----------
+^^^^^^^^^^
 
 .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
 
@@ -283,7 +283,7 @@ See Also
        The official documentation on the **ns2.col.foo** module.
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml+jinja
 

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_role.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_role.rst
@@ -123,7 +123,7 @@ Parameters
 
 
 Attributes
-----------
+^^^^^^^^^^
 
 .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
 
@@ -236,7 +236,7 @@ See Also
        The official documentation on the **ns2.col.foo** module.
 
 Examples
---------
+^^^^^^^^
 
 .. code-block:: yaml+jinja
-Original file line number
+Diff line change
@@ Expand Up / @@ -68,7 +68,7 @@ Synopsis @@
     Examples
-    --------
+    ^^^^^^^^
     .. code-block:: yaml+jinja
@@ Expand Down @@