1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

[WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)

Disambiguates autogenerated module docs - fixes #38439.
This commit is contained in:
scottb 2018-04-17 18:45:07 -07:00 committed by GitHub
parent 50d151aef2
commit c97e508806
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 30 additions and 24 deletions

View file

@ -33,7 +33,7 @@ An `example file is available on Github <https://raw.github.com/ansible/ansible/
For more details and a full listing of available configurations go to :ref:`configuration_settings`. Starting with Ansible version 2.4, you can use the :ref:`ansible-config` command line utility to list your available options and inspect the current values. For more details and a full listing of available configurations go to :ref:`configuration_settings`. Starting with Ansible version 2.4, you can use the :ref:`ansible-config` command line utility to list your available options and inspect the current values.
For in-depth details, see :ref:`config`. For in-depth details, see :ref:`ansible_configuration_settings`.
Environmental configuration Environmental configuration
@ -42,7 +42,8 @@ Environmental configuration
Ansible also allows configuration of settings using environment variables. Ansible also allows configuration of settings using environment variables.
If these environment variables are set, they will override any setting loaded from the configuration file. If these environment variables are set, they will override any setting loaded from the configuration file.
You can get a full listing of available environment variables from :doc:`_config`. You can get a full listing of available environment variables from :ref:`ansible_configuration_settings`.
.. _command_line_configuration: .. _command_line_configuration:

View file

@ -50,13 +50,13 @@ or for my custom callback:
stdout_callback = mycallback stdout_callback = mycallback
This only affects :doc:`../ansible-playbook` by default. This only affects :ref:`ansible-playbook` by default.
Managing AdHoc Managing AdHoc
`````````````` ``````````````
The :doc:`ansible <../ansible>` AdHoc command specifically uses a different callback plugin for stdout, The :ref:`ansible` ad hoc command specifically uses a different callback plugin for stdout,
so there is an extra setting in :doc:`ansible.cfg <../config>` you need to add to use the stdout callback defined above: so there is an extra setting in :ref:`ansible_configuration_settings` you need to add to use the stdout callback defined above:
.. code-block:: ini .. code-block:: ini
@ -87,19 +87,21 @@ Use ``ansible-doc -t callback <plugin name>`` to see specific documents and exam
.. seealso:: .. seealso::
:doc:`../playbooks` :doc:`action`
An introduction to playbooks Ansible Action plugins
:doc:`cache`
Ansible cache plugins
:doc:`connection`
Ansible connection plugins
:doc:`inventory` :doc:`inventory`
Ansible inventory plugins Ansible inventory plugins
:doc:`../playbooks_filters` :doc:`shell`
Jinja2 filter plugins Ansible Shell plugins
:doc:`../playbooks_tests` :doc:`strategy`
Jinja2 test plugins Ansible Strategy plugins
:doc:`../playbooks_lookups`
Jinja2 lookup plugins
:doc:`vars` :doc:`vars`
Ansible vars plugins Ansible Vars plugins
`User Mailing List <http://groups.google.com/group/ansible-devel>`_ `User Mailing List <https://groups.google.com/forum/#!forum/ansible-devel>`_
Have a question? Stop by the google group! Have a question? Stop by the google group!
`irc.freenode.net <http://irc.freenode.net>`_ `webchat.freenode.net <https://webchat.freenode.net>`_
#ansible IRC chat channel #ansible IRC chat channel

View file

@ -94,11 +94,12 @@ specify that all of the time. We'll use ``-m`` in later examples to
run some other :doc:`modules`. run some other :doc:`modules`.
.. note:: .. note::
The :ref:`command` module does not support extended shell syntax like piping and redirects (although The :ref:`command module <module_command>` does not support extended shell syntax like piping and
shell variables will always work). If your command requires shell-specific syntax, use the `shell` module redirects (although shell variables will always work). If your command requires shell-specific
instead. Read more about the differences on the :ref:`working_with_modules` page. syntax, use the `shell` module instead. Read more about the differences on the
:ref:`working_with_modules` page.
Using the :ref:`shell` module looks like this:: Using the :ref:`shell module <module_shell>` looks like this::
$ ansible raleigh -m shell -a 'echo $TERM' $ ansible raleigh -m shell -a 'echo $TERM'

View file

@ -1,3 +1,5 @@
.. _ansible_configuration_settings:
{% set name = 'Ansible Configuration Settings' -%} {% set name = 'Ansible Configuration Settings' -%}
{% set name_slug = 'config' -%} {% set name_slug = 'config' -%}

View file

@ -11,7 +11,7 @@
{% if category['_modules'] %} {% if category['_modules'] %}
{% for module in category['_modules'] | sort %} {% for module in category['_modules'] | sort %}
* :ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} * :ref:`@{ module }@_@{ plugin_type }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%}
{% endfor %} {% endfor %}
{% endif %} {% endif %}
@ -25,7 +25,7 @@
{% for module in info['_modules'] | sort %} {% for module in info['_modules'] | sort %}
* :ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} * :ref:`@{ module }@_@{ plugin_type }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%}
{% endfor %} {% endfor %}
{% endfor %} {% endfor %}

View file

@ -4,7 +4,7 @@ Modules Maintained by the @{ maintainers }@
``````````````````````````@{ '`' * maintainers | length }@ ``````````````````````````@{ '`' * maintainers | length }@
{% for module in modules | sort %} {% for module in modules | sort %}
* :ref:`@{ module }@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%} * :ref:`@{ module }@_@{plugin_type}@`{% if module_info[module]['deprecated'] %} **(D)**{% endif%}
{% endfor %} {% endfor %}
.. note:: .. note::

View file

@ -1,6 +1,6 @@
:source: @{ source }@ :source: @{ source }@
.. _@{ module }@: .. _@{ module }@_@{ plugin_type }@:
{% for alias in aliases %} {% for alias in aliases %}
.. _@{ alias }@: .. _@{ alias }@:
{% endfor %} {% endfor %}