mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 05:40:23 -07:00
Revamp the plugin_formatter doc generator
* Use a template to generate the category lists * Refactor so that we first extract all of the data that we need to build the docs and then give that data to the templates to build with * Add docs page listing modules ordered by support level
This commit is contained in:
parent
af2073d057
commit
546187a8af
5 changed files with 317 additions and 234 deletions
15
docs/templates/modules_by_support.rst.j2
vendored
Normal file
15
docs/templates/modules_by_support.rst.j2
vendored
Normal file
|
@ -0,0 +1,15 @@
|
|||
.. _@{ slug }@:
|
||||
|
||||
Modules Maintained by the @{ maintainers }@
|
||||
``````````````````````````@{ '`' * maintainers | length }@
|
||||
|
||||
.. toctree:: :maxdepth: 1
|
||||
|
||||
{% for module in modules | sort %}
|
||||
@{ module }@{% if module_info[module]['deprecated'] %}**(D)**{% endif %} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
{% 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