mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 21:32:49 +00:00
Misc docs fixes
* Revise and link inline to the lists of modules * Fix jinja2 objects.inv fallback path * Fix bolding of deprecation marker * Change module_support to link to lists via :doc: That links to the top of the page instead of a section. * Add a short text for each list of maintained modules * Change maintenance info to only display on core and network modules
This commit is contained in:
@@ -1,6 +1,10 @@
|
||||
@{ title }@ Modules
|
||||
@{ '`' * title | length }@````````
|
||||
|
||||
{% if blurb %}
|
||||
@{ blurb }@
|
||||
|
||||
{% endif %}
|
||||
.. toctree:: :maxdepth: 1
|
||||
{% if category['_modules'] %}
|
||||
|
||||
@@ -16,7 +20,7 @@
|
||||
.. toctree:: :maxdepth: 1
|
||||
|
||||
{% for module in info['_modules'] | sort %}
|
||||
@{ module }@{% if module_info[module]['deprecated'] %}**(D)**{% endif%} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
@{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif%} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
{% endfor %}
|
||||
|
||||
{% endfor %}
|
||||
|
||||
2
docs/templates/modules_by_support.rst.j2
vendored
2
docs/templates/modules_by_support.rst.j2
vendored
@@ -6,7 +6,7 @@ Modules Maintained by the @{ maintainers }@
|
||||
.. toctree:: :maxdepth: 1
|
||||
|
||||
{% for module in modules | sort %}
|
||||
@{ module }@{% if module_info[module]['deprecated'] %}**(D)**{% endif %} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
@{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif %} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module>
|
||||
{% endfor %}
|
||||
|
||||
.. note::
|
||||
|
||||
12
docs/templates/plugin.rst.j2
vendored
12
docs/templates/plugin.rst.j2
vendored
@@ -279,15 +279,13 @@ Status
|
||||
This module is flagged as **@{cur_state}@** which means that @{module_states[cur_state]}@.
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if metadata.supported_by in ('core', 'network') %}
|
||||
|
||||
{% if metadata.supported_by %}
|
||||
Maintenance Info
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Support Level
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
This module is maintained by @{ support[metadata.supported_by] }@
|
||||
|
||||
For more information on what this means please read :doc:`modules_support`.
|
||||
For more information about Red Hat's this support of this module, please
|
||||
refer to this `knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>`
|
||||
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
Reference in New Issue
Block a user