cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Removes modules from TOC, speeding up build time and reducing doc disk space requirements.

Browse source
This commit is contained in:
Scott Butler 2018-04-04 18:55:39 -07:00 committed by Toshio Kuratomi
parent 1c7b9e66b4
commit 62c2b9a544
4 changed files with 12 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/docsite/rst/index.rst
View file

@ -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

6
docs/docsite/rst/user_guide/modules_support.rst
View file

@ -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<list_of_network_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
```````````````

9
docs/templates/list_of_CATEGORY_modules.rst.j2 vendored
View file

@ -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 %}

4
docs/templates/modules_by_support.rst.j2 vendored
View file

@ -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::