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:
Toshio Kuratomi
2017-08-16 07:05:14 -07:00
parent 84ea2af4b6
commit 40ea448c7b
6 changed files with 54 additions and 35 deletions

View File

@@ -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 %}

View File

@@ -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::

View File

@@ -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 %}