Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix more docs errors. #39051

Merged
merged 2 commits into from
Apr 20, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/bin/testing_formatter.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/docsite/rst/plugins/callback.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
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:
Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/plugins/connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Plugins are self-documenting. Each plugin should document its configuration opti
:ref:`ansible_host<ansible_host>`
The name of the host to connect to, if different from the :ref:`inventory hostname<inventory_hostname>`.
: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>`
The default user name to use for log in. Most plugins default to the 'current user running Ansible'.

Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/user_guide/modules_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/user_guide/plugin_filtering_config.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _plugin_filter_config:
.. _plugin_filtering_config:

Plugin Filter Configuration
===========================
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/config/base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions test/sanity/code-smell/docs-build.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
]
Expand Down