From e60c4d46908e4de4d4af5348eff21968f3e54b2f Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Fri, 6 Apr 2018 15:12:05 -0700 Subject: [PATCH] Removes modules from TOC, speeding up build time and reducing doc disk space requirements. (#38428) (cherry picked from commit 62c2b9a544adb8ffff340a261aefd9752be9d392) --- docs/docsite/rst/index.rst | 8 ++++---- docs/docsite/rst/user_guide/modules_support.rst | 6 +++--- docs/templates/list_of_CATEGORY_modules.rst.j2 | 9 ++++----- docs/templates/modules_by_support.rst.j2 | 4 +--- 4 files changed, 12 insertions(+), 15 deletions(-) diff --git a/docs/docsite/rst/index.rst b/docs/docsite/rst/index.rst index 686097d4917..efcb7f939c4 100644 --- a/docs/docsite/rst/index.rst +++ b/docs/docsite/rst/index.rst @@ -1,4 +1,4 @@ -:tocdepth: 3 +.. _ansible_documentation: Ansible Documentation ===================== @@ -28,19 +28,19 @@ Ansible releases a new major release of Ansible approximately every two months. porting_guides/porting_guides .. toctree:: - :maxdepth: 3 + :maxdepth: 2 :caption: Using Ansible user_guide/index .. toctree:: - :maxdepth: 3 + :maxdepth: 2 :caption: Contributing to Ansible community/index .. toctree:: - :maxdepth: 3 + :maxdepth: 2 :caption: Extending Ansible dev_guide/index diff --git a/docs/docsite/rst/user_guide/modules_support.rst b/docs/docsite/rst/user_guide/modules_support.rst index ef08613395c..5f9d53ff226 100644 --- a/docs/docsite/rst/user_guide/modules_support.rst +++ b/docs/docsite/rst/user_guide/modules_support.rst @@ -8,13 +8,13 @@ To help identify maintainers and understand how the included modules are officia Core ```` -:doc:`Core modules are maintained by the Ansible Engineering Team<..\modules\core_maintained>`. +:ref:`core_supported`. These are maintained by the Ansible Engineering Team. These modules are integral to the basic foundations of the Ansible distribution. Network ``````` -:doc:`Network modules are maintained by the Ansible Network Team<..\modules\network_maintained>`. Please note there are :doc:`additional networking modules` that are categorized as Certified or Community not maintained by Ansible. +:ref:`network_supported`. These are maintained by the Ansible Network Team. Please note there are additional networking modules that are categorized as Certified or Community not maintained by Ansible. Certified @@ -25,7 +25,7 @@ Certified modules are part of a future planned program currently in development. Community ````````` -:doc:`Community modules are submitted and maintained by the Ansible community<..\modules\community_maintained>`. These modules are not maintained by Ansible, and are included as a convenience. +:ref:`community_supported`. These are submitted and maintained by the Ansible community. These modules are not maintained by Ansible, and are included as a convenience. Issue Reporting ``````````````` diff --git a/docs/templates/list_of_CATEGORY_modules.rst.j2 b/docs/templates/list_of_CATEGORY_modules.rst.j2 index 301449e2e7b..05ab5e2f5e2 100644 --- a/docs/templates/list_of_CATEGORY_modules.rst.j2 +++ b/docs/templates/list_of_CATEGORY_modules.rst.j2 @@ -7,11 +7,11 @@ @{ blurb }@ {% endif %} -.. toctree:: :maxdepth: 1 + {% if category['_modules'] %} {% for module in category['_modules'] | sort %} - @{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif%} -- @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module> + * :ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} {% endfor %} {% endif %} @@ -22,11 +22,10 @@ @{ 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'] }@ #} - @{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif%} -- @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module> + * :ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} {% endfor %} {% endfor %} diff --git a/docs/templates/modules_by_support.rst.j2 b/docs/templates/modules_by_support.rst.j2 index d40c3e1712a..1446e1592bf 100644 --- a/docs/templates/modules_by_support.rst.j2 +++ b/docs/templates/modules_by_support.rst.j2 @@ -3,10 +3,8 @@ Modules Maintained by the @{ maintainers }@ ``````````````````````````@{ '`' * maintainers | length }@ -.. toctree:: :maxdepth: 1 - {% for module in modules | sort %} - @{ module }@{% if module_info[module]['deprecated'] %} **(D)**{% endif %} - @{ module_info[module]['doc']['short_description'] }@ <@{ module }@_module> + * :ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} {% endfor %} .. note::