da15cf1f54
Generate rst docs for plugins Based on rst generated for modules. But generated plugin docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst ( docs/docsite/rst/plugins/connection/ssh.py for ex) * move plugins docs to rst/*_plugins/ subdirs for namespace * Only gen support pages for modules for now. * Add generated plugin docs to gitignore* add list_*_plugins templates * support MODULES/PLUGINS filters for make htmldocs Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for. * fixup 'historical' version_added, skip plugins/loader.py * Fix plugins_by_support ref link to new plugins/*/ location * use :ref: for common_return_values, allow empty version_added * warnings on missing doc info * add a prefix to _random_choice It was colliding with the target for random_choice plugin
31 lines
1 KiB
Django/Jinja
31 lines
1 KiB
Django/Jinja
@{ title }@ @{ plugin_type }@
|
|
@{ '`' * title | length }@````````
|
|
|
|
{% if blurb %}
|
|
@{ blurb }@
|
|
|
|
{% endif %}
|
|
.. toctree:: :maxdepth: 1
|
|
{% if category['_modules'] %}
|
|
|
|
{% for module in category['_modules'] | sort %}
|
|
@{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif%}{% if module_info[module]['doc']['short_description'] %} - @{ module_info[module]['doc']['short_description'] }@{% endif %} <plugins/@{ module_info[module]['primary_category'] }@/@{ module }@>
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
{% for name, info in subcategories.items() | sort %}
|
|
@{ name.title() }@
|
|
@{ '-' * name | length }@
|
|
|
|
.. toctree:: :maxdepth: 1
|
|
|
|
{% for module in info['_modules'] | sort %}
|
|
:ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} @{ module_info[module]['doc']['short_description'] }@
|
|
{% 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.
|
|
|