From 9e8889bb70a1f6379414ea51f644d98dea1d1d10 Mon Sep 17 00:00:00 2001 From: Matt Clay Date: Fri, 20 Apr 2018 00:24:47 -0700 Subject: [PATCH] Fix more docs errors. (#39051) * Fix remaining unknown-document docs errors. * Fix last toc-tree-missing-document docs error. --- docs/bin/testing_formatter.sh | 2 +- docs/docsite/rst/plugins/callback.rst | 2 +- docs/docsite/rst/plugins/connection.rst | 2 +- docs/docsite/rst/user_guide/modules_intro.rst | 2 +- docs/docsite/rst/user_guide/plugin_filtering_config.rst | 2 +- lib/ansible/config/base.yml | 2 +- test/sanity/code-smell/docs-build.py | 2 -- 7 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/bin/testing_formatter.sh b/docs/bin/testing_formatter.sh index 97423199e49..0867f9a54ef 100755 --- a/docs/bin/testing_formatter.sh +++ b/docs/bin/testing_formatter.sh @@ -10,7 +10,7 @@ This list is also available using \`\`ansible-test sanity --list-tests\`\`. .. toctree:: :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 diff --git a/docs/docsite/rst/plugins/callback.rst b/docs/docsite/rst/plugins/callback.rst index ff9f18721ae..425d2ad6dd9 100644 --- a/docs/docsite/rst/plugins/callback.rst +++ b/docs/docsite/rst/plugins/callback.rst @@ -16,7 +16,7 @@ Example Callback Plugins The :doc:`_plays ` callback is an example of how to record playbook events to a log file, and the :doc:`mail ` callback sends email on playbook failures. -The :doc:`osx_say ` callback responds with computer synthesized speech on OS X in relation to playbook events. +The :doc:`osx_say ` callback responds with computer synthesized speech on OS X in relation to playbook events. .. _enabling_callbacks: diff --git a/docs/docsite/rst/plugins/connection.rst b/docs/docsite/rst/plugins/connection.rst index 5168cfa2f45..cdba361764f 100644 --- a/docs/docsite/rst/plugins/connection.rst +++ b/docs/docsite/rst/plugins/connection.rst @@ -43,7 +43,7 @@ Plugins are self-documenting. Each plugin should document its configuration opti :ref:`ansible_host` The name of the host to connect to, if different from the :ref:`inventory hostname`. :ref:`ansible_port` - The ssh port number, for :doc:`ssh ` and :doc:`paramiko ` it defaults to 22. + The ssh port number, for :doc:`ssh ` and :doc:`paramiko_ssh ` it defaults to 22. :ref:`ansible_user` The default user name to use for log in. Most plugins default to the 'current user running Ansible'. diff --git a/docs/docsite/rst/user_guide/modules_intro.rst b/docs/docsite/rst/user_guide/modules_intro.rst index 47df4a28763..a598c35bd7d 100644 --- a/docs/docsite/rst/user_guide/modules_intro.rst +++ b/docs/docsite/rst/user_guide/modules_intro.rst @@ -44,7 +44,7 @@ Documentation for each module can be accessed from the command line with the ans 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 diff --git a/docs/docsite/rst/user_guide/plugin_filtering_config.rst b/docs/docsite/rst/user_guide/plugin_filtering_config.rst index e17a7aadaa7..04fb0d368d6 100644 --- a/docs/docsite/rst/user_guide/plugin_filtering_config.rst +++ b/docs/docsite/rst/user_guide/plugin_filtering_config.rst @@ -1,4 +1,4 @@ -.. _plugin_filter_config: +.. _plugin_filtering_config: Plugin Filter Configuration =========================== diff --git a/lib/ansible/config/base.yml b/lib/ansible/config/base.yml index b640689b6a9..c28cef1cd8c 100644 --- a/lib/ansible/config/base.yml +++ b/lib/ansible/config/base.yml @@ -1473,7 +1473,7 @@ PLUGIN_FILTERS_CFG: version_added: "2.5.0" description: - "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" ini: - key: plugin_filters_cfg diff --git a/test/sanity/code-smell/docs-build.py b/test/sanity/code-smell/docs-build.py index bdf3e5027a1..010c1e7d9d4 100755 --- a/test/sanity/code-smell/docs-build.py +++ b/test/sanity/code-smell/docs-build.py @@ -39,8 +39,6 @@ def main(): ignore_codes = [ 'literal-block-lex-error', 'undefined-label', - 'unknown-document', - 'toc-tree-missing-document', 'reference-target-not-found', 'not-in-toc-tree', ]