mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
Modules tocfix (#51077)
define & create subcategories, output by category and subcat
This commit is contained in:
parent
2d83db7036
commit
3eec7f1820
2 changed files with 56 additions and 7 deletions
37
docs/templates/modules_by_support.rst.j2
vendored
37
docs/templates/modules_by_support.rst.j2
vendored
|
@ -3,14 +3,43 @@
|
|||
{# avoids rST "isn't included in any toctree" errors for module index docs #}
|
||||
:orphan:
|
||||
|
||||
**************************@{ '*' * maintainers | length }@
|
||||
Modules Maintained by the @{ maintainers }@
|
||||
``````````````````````````@{ '`' * maintainers | length }@
|
||||
**************************@{ '*' * maintainers | length }@
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
{% for category, data in subcategories.items() | sort %}
|
||||
|
||||
{% if category.lower() %}
|
||||
.. _@{ category.lower() + '_' + slug.lower() + '_categories' }@:
|
||||
{% else %}
|
||||
.. _@{ slug.lower() + '_categories' }@:
|
||||
{% endif %}
|
||||
|
||||
@{ category.title() }@
|
||||
@{ '=' * category | length }@
|
||||
|
||||
{% for name, info in data.items() | sort %}
|
||||
|
||||
{% if name.lower() %}
|
||||
.. _@{ name.lower() + '_' + category + '_' + slug.lower() + '_' + plugin_type + 's' }@:
|
||||
{% else %}
|
||||
.. _@{ slug.lower() + '_' + category }@:
|
||||
{% endif %}
|
||||
|
||||
@{ name.title() }@
|
||||
@{ '-' * name | length }@
|
||||
|
||||
{% for module in info['_modules'] | sort %}
|
||||
* :ref:`@{ module }@_@{plugin_type}@`{% if module_info[module]['deprecated'] %} **(D)** {% endif%}
|
||||
{% endfor %}
|
||||
|
||||
{% endfor %}
|
||||
|
||||
{% for module in modules | sort %}
|
||||
* :ref:`@{ module }@_@{plugin_type}@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%}
|
||||
{% endfor %}
|
||||
|
||||
.. note::
|
||||
- **(D)**: This marks a module as deprecated, which means a module is kept for backwards compatibility but usage is discouraged.
|
||||
The module documentation details page may explain more about this rationale.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue