4c4406b2df
* Flatten the directory hierarchy of modules * Update ignore.txt, flatten units * Update imports * Completely flatten the modules directory * Update sanity ignore * Fix some sanity test ignores * Fix relative import * Fix docs builds without category * ci_complete * Clean up docs. ci_complete * Adjust needs/file alias * ci_complete * fix hardcoded ping module paths Co-authored-by: Matt Davis <mrd@redhat.com>
48 lines
1.1 KiB
Django/Jinja
48 lines
1.1 KiB
Django/Jinja
{# avoids rST "isn't included in any toctree" errors for module docs #}
|
|
:orphan:
|
|
|
|
{% if title %}
|
|
.. _@{ title.lower() + '_' + plugin_type + 's' }@:
|
|
{% else %}
|
|
.. _@{ plugin_type + 's' }@:
|
|
{% endif %}
|
|
|
|
{% if title %}
|
|
@{ title }@ @{ plugin_type + 's' }@
|
|
@{ '`' * title | length }@````````
|
|
{% else %}
|
|
@{ plugin_type + 's' }@
|
|
```````
|
|
{% endif %}
|
|
|
|
{% if blurb %}
|
|
@{ blurb }@
|
|
|
|
{% endif %}
|
|
|
|
{% if category['_modules'] %}
|
|
|
|
{% for module in category['_modules'] | sort %}
|
|
* :ref:`@{ module }@_@{ plugin_type }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%}
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
{% for name, info in subcategories.items() | sort %}
|
|
|
|
.. _@{ name.lower() + '_' + title.lower() + '_' + plugin_type + 's' }@:
|
|
|
|
@{ name.title() }@
|
|
@{ '-' * name | length }@
|
|
|
|
|
|
|
|
{% for module in info['_modules'] | sort %}
|
|
* :ref:`@{ module }@_@{ plugin_type }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%}
|
|
{% endfor %}
|
|
|
|
{% 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.
|
|
|