mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Disambiguates autogenerated module docs - fixes #38439.
This commit is contained in:
parent
50d151aef2
commit
c97e508806
7 changed files with 30 additions and 24 deletions
|
@ -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 in-depth details, see :ref:`config`.
|
||||
For in-depth details, see :ref:`ansible_configuration_settings`.
|
||||
|
||||
|
||||
Environmental configuration
|
||||
|
@ -42,7 +42,8 @@ Environmental configuration
|
|||
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.
|
||||
|
||||
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:
|
||||
|
||||
|
|
|
@ -50,13 +50,13 @@ or for my custom callback:
|
|||
|
||||
stdout_callback = mycallback
|
||||
|
||||
This only affects :doc:`../ansible-playbook` by default.
|
||||
This only affects :ref:`ansible-playbook` by default.
|
||||
|
||||
Managing AdHoc
|
||||
``````````````
|
||||
|
||||
The :doc:`ansible <../ansible>` AdHoc 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:
|
||||
The :ref:`ansible` ad hoc command specifically uses a different callback plugin for stdout,
|
||||
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
|
||||
|
||||
|
@ -87,19 +87,21 @@ Use ``ansible-doc -t callback <plugin name>`` to see specific documents and exam
|
|||
|
||||
.. seealso::
|
||||
|
||||
:doc:`../playbooks`
|
||||
An introduction to playbooks
|
||||
:doc:`action`
|
||||
Ansible Action plugins
|
||||
:doc:`cache`
|
||||
Ansible cache plugins
|
||||
:doc:`connection`
|
||||
Ansible connection plugins
|
||||
:doc:`inventory`
|
||||
Ansible inventory plugins
|
||||
:doc:`../playbooks_filters`
|
||||
Jinja2 filter plugins
|
||||
:doc:`../playbooks_tests`
|
||||
Jinja2 test plugins
|
||||
:doc:`../playbooks_lookups`
|
||||
Jinja2 lookup plugins
|
||||
:doc:`shell`
|
||||
Ansible Shell plugins
|
||||
:doc:`strategy`
|
||||
Ansible Strategy plugins
|
||||
:doc:`vars`
|
||||
Ansible vars plugins
|
||||
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
|
||||
Ansible Vars plugins
|
||||
`User Mailing List <https://groups.google.com/forum/#!forum/ansible-devel>`_
|
||||
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
|
||||
|
|
|
@ -94,11 +94,12 @@ specify that all of the time. We'll use ``-m`` in later examples to
|
|||
run some other :doc:`modules`.
|
||||
|
||||
.. note::
|
||||
The :ref:`command` module does not support extended shell syntax like piping and redirects (although
|
||||
shell variables will always work). If your command requires shell-specific syntax, use the `shell` module
|
||||
instead. Read more about the differences on the :ref:`working_with_modules` page.
|
||||
The :ref:`command module <module_command>` does not support extended shell syntax like piping and
|
||||
redirects (although shell variables will always work). If your command requires shell-specific
|
||||
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'
|
||||
|
||||
|
|
2
docs/templates/config.rst.j2
vendored
2
docs/templates/config.rst.j2
vendored
|
@ -1,3 +1,5 @@
|
|||
.. _ansible_configuration_settings:
|
||||
|
||||
{% set name = 'Ansible Configuration Settings' -%}
|
||||
{% set name_slug = 'config' -%}
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
{% if category['_modules'] %}
|
||||
|
||||
{% 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 %}
|
||||
{% endif %}
|
||||
|
||||
|
@ -25,7 +25,7 @@
|
|||
|
||||
|
||||
{% 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 %}
|
||||
|
|
2
docs/templates/modules_by_support.rst.j2
vendored
2
docs/templates/modules_by_support.rst.j2
vendored
|
@ -4,7 +4,7 @@ Modules Maintained by the @{ maintainers }@
|
|||
``````````````````````````@{ '`' * maintainers | length }@
|
||||
|
||||
{% 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 %}
|
||||
|
||||
.. note::
|
||||
|
|
2
docs/templates/plugin.rst.j2
vendored
2
docs/templates/plugin.rst.j2
vendored
|
@ -1,6 +1,6 @@
|
|||
:source: @{ source }@
|
||||
|
||||
.. _@{ module }@:
|
||||
.. _@{ module }@_@{ plugin_type }@:
|
||||
{% for alias in aliases %}
|
||||
.. _@{ alias }@:
|
||||
{% endfor %}
|
||||
|
|
Loading…
Reference in a new issue