From 3016bc7351a490008362e4b190533ddffc68bf70 Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Sat, 24 Feb 2018 14:06:12 +0100 Subject: [PATCH] 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 --- docs/docsite/_themes/sphinx_rtd_theme/footer.html | 4 ++-- docs/templates/list_of_CATEGORY_plugins.rst.j2 | 2 +- docs/templates/plugin.rst.j2 | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docsite/_themes/sphinx_rtd_theme/footer.html b/docs/docsite/_themes/sphinx_rtd_theme/footer.html index 55ca16a8483..c7e1e0cb636 100644 --- a/docs/docsite/_themes/sphinx_rtd_theme/footer.html +++ b/docs/docsite/_themes/sphinx_rtd_theme/footer.html @@ -22,7 +22,7 @@

- Copyright © 2017 Red Hat, Inc. + Copyright © 2018 Red Hat, Inc.
{%- if last_updated %} @@ -30,6 +30,6 @@ {%- endif %}

-Ansible docs are generated from GitHub sources using Sphinx using a theme provided by Read the Docs. {% if pagename.endswith("_module") %}Module documentation is not edited directly, but is generated from the source code for the modules. To submit an update to module docs, edit the 'DOCUMENTATION' metadata in the modules directory of the core source code repository. {% endif %} +Ansible docs are generated from GitHub sources using Sphinx using a theme provided by Read the Docs.

diff --git a/docs/templates/list_of_CATEGORY_plugins.rst.j2 b/docs/templates/list_of_CATEGORY_plugins.rst.j2 index 0ea014da817..fba836c68b6 100644 --- a/docs/templates/list_of_CATEGORY_plugins.rst.j2 +++ b/docs/templates/list_of_CATEGORY_plugins.rst.j2 @@ -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 %} diff --git a/docs/templates/plugin.rst.j2 b/docs/templates/plugin.rst.j2 index cea36c4f929..4cdc6c1a8ab 100644 --- a/docs/templates/plugin.rst.j2 +++ b/docs/templates/plugin.rst.j2 @@ -211,7 +211,7 @@ Examples Return Values ------------- -Common return values are documented :ref:`here `, the following are the fields unique to this {{plugin_type}}: +Common return values are documented :ref:`here `, 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 %}