Fix more docs errors. (#39051)

* Fix remaining unknown-document docs errors.
* Fix last toc-tree-missing-document docs error.
This commit is contained in:
Matt Clay 2018-04-20 00:24:47 -07:00 committed by GitHub
parent dbd0272f2e
commit 9e8889bb70
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 6 additions and 8 deletions

View file

@ -10,7 +10,7 @@ This list is also available using \`\`ansible-test sanity --list-tests\`\`.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
$(for test in $(../../test/runner/ansible-test sanity --list-tests); do echo " ${test}"; done) $(for test in $(../../test/runner/ansible-test sanity --list-tests); do echo " ${test}"; done)
EOF EOF

View file

@ -16,7 +16,7 @@ Example Callback Plugins
The :doc:`_plays <callback/log_plays>` callback is an example of how to record playbook events to a log file, The :doc:`_plays <callback/log_plays>` callback is an example of how to record playbook events to a log file,
and the :doc:`mail <callback/mail>` callback sends email on playbook failures. and the :doc:`mail <callback/mail>` callback sends email on playbook failures.
The :doc:`osx_say <callback/oxs_say>` callback responds with computer synthesized speech on OS X in relation to playbook events. The :doc:`osx_say <callback/osx_say>` callback responds with computer synthesized speech on OS X in relation to playbook events.
.. _enabling_callbacks: .. _enabling_callbacks:

View file

@ -43,7 +43,7 @@ Plugins are self-documenting. Each plugin should document its configuration opti
:ref:`ansible_host<ansible_host>` :ref:`ansible_host<ansible_host>`
The name of the host to connect to, if different from the :ref:`inventory hostname<inventory_hostname>`. The name of the host to connect to, if different from the :ref:`inventory hostname<inventory_hostname>`.
:ref:`ansible_port<ansible_port>` :ref:`ansible_port<ansible_port>`
The ssh port number, for :doc:`ssh <connection/ssh>` and :doc:`paramiko <connection/paramiko>` it defaults to 22. The ssh port number, for :doc:`ssh <connection/ssh>` and :doc:`paramiko_ssh <connection/paramiko_ssh>` it defaults to 22.
:ref:`ansible_user<ansible_user>` :ref:`ansible_user<ansible_user>`
The default user name to use for log in. Most plugins default to the 'current user running Ansible'. The default user name to use for log in. Most plugins default to the 'current user running Ansible'.

View file

@ -44,7 +44,7 @@ Documentation for each module can be accessed from the command line with the ans
ansible-doc yum ansible-doc yum
For a list of all available modules, see :doc:`modules_by_category`, or run the following at a command prompt:: For a list of all available modules, see :doc:`../modules/modules_by_category`, or run the following at a command prompt::
ansible-doc -l ansible-doc -l

View file

@ -1,4 +1,4 @@
.. _plugin_filter_config: .. _plugin_filtering_config:
Plugin Filter Configuration Plugin Filter Configuration
=========================== ===========================

View file

@ -1473,7 +1473,7 @@ PLUGIN_FILTERS_CFG:
version_added: "2.5.0" version_added: "2.5.0"
description: description:
- "A path to configuration for filtering which plugins installed on the system are allowed to be used." - "A path to configuration for filtering which plugins installed on the system are allowed to be used."
- "See :doc:`plugin_filtering_config` for details of the filter file's format." - "See :ref:`plugin_filtering_config` for details of the filter file's format."
- " The default is /etc/ansible/plugin_filters.yml" - " The default is /etc/ansible/plugin_filters.yml"
ini: ini:
- key: plugin_filters_cfg - key: plugin_filters_cfg

View file

@ -39,8 +39,6 @@ def main():
ignore_codes = [ ignore_codes = [
'literal-block-lex-error', 'literal-block-lex-error',
'undefined-label', 'undefined-label',
'unknown-document',
'toc-tree-missing-document',
'reference-target-not-found', 'reference-target-not-found',
'not-in-toc-tree', 'not-in-toc-tree',
] ]