Asorted docs fixed (#36672)

This PR includes:
- A fix to untemplated {{ plugin_type }} in docs
- Remove the additional info on how to edit module docs (see #36667)
- Add missing delimiter
This commit is contained in:
Dag Wieers
2018-02-24 14:06:12 +01:00
committed by GitHub
parent ba370b178d
commit 3016bc7351
3 changed files with 5 additions and 5 deletions

View File

@@ -25,7 +25,7 @@
.. toctree:: :maxdepth: 1
{% for module in info['_modules'] | sort %}
:ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} @{ module_info[module]['doc']['short_description'] }@
:ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} -- @{ module_info[module]['doc']['short_description'] }@
{% endfor %}
{% endfor %}

View File

@@ -211,7 +211,7 @@ Examples
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this {{plugin_type}}:
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this @{ plugin_type }@:
.. raw:: html
@@ -287,7 +287,7 @@ Author
~~~~~~
{% for author_name in author %}
* @{ author_name }@
* @{ author_name }@
{% endfor %}