summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlicia Cozine <cozi@visi.com>2018-04-27 13:55:13 -0500
committerGitHub <noreply@github.com>2018-04-27 13:55:13 -0500
commit7577a8c24dc17c865a1d6d303d74cfa8d8d7175b (patch)
treec8ac9796a75900b21a00a5ec94bead825faa4fa5 /docs
parent86663c8060a5086bd99fa220281143c66cfff02a (diff)
downloadansible-7577a8c24dc17c865a1d6d303d74cfa8d8d7175b.tar.gz
Last docs link fixes (#39391) (#39445)
* should not need <>, but fails without * adds anchor to keywords page, uses it on plugins pages * fixes envvar link errors * harmonize file name and ref name as python_3 (cherry picked from commit c8a9b411bc7a2dedf812ca38b5dfdd61696fdc38)
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/rst/dev_guide/developing_modules.rst2
-rw-r--r--docs/docsite/rst/dev_guide/developing_modules_checklist.rst6
-rw-r--r--docs/docsite/rst/dev_guide/developing_modules_general_windows.rst2
-rw-r--r--docs/docsite/rst/dev_guide/developing_python_3.rst (renamed from docs/docsite/rst/dev_guide/developing_python3.rst)0
-rw-r--r--docs/docsite/rst/dev_guide/index.rst2
-rw-r--r--docs/docsite/rst/plugins/connection.rst2
-rw-r--r--docs/docsite/rst/plugins/strategy.rst2
-rw-r--r--docs/docsite/rst/reference_appendices/faq.rst2
-rw-r--r--docs/templates/playbooks_keywords.rst.j22
9 files changed, 11 insertions, 9 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules.rst b/docs/docsite/rst/dev_guide/developing_modules.rst
index df3cd0d8b8..f4d0b2b9b1 100644
--- a/docs/docsite/rst/dev_guide/developing_modules.rst
+++ b/docs/docsite/rst/dev_guide/developing_modules.rst
@@ -87,7 +87,7 @@ The following topics will discuss how to develop and work with modules:
Checklist for contributing your module to Ansible.
:doc:`testing`
Developing unit and integration tests.
-:doc:`developing_python3`
+:ref:`developing_python_3`
Adding Python 3 support to modules (all new modules must be Python-2.6 and Python-3.5 compatible).
:doc:`developing_modules_in_groups`
A guide for partners wanting to submit multiple modules.
diff --git a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst
index 9538066e68..a18b5c2e49 100644
--- a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst
+++ b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst
@@ -23,7 +23,7 @@ The following checklist items are important guidelines for people who want to c
* The shebang must always be ``#!/usr/bin/python``. This allows ``ansible_python_interpreter`` to work
* Modules must be written to support Python 2.6. If this is not possible, required minimum Python version and rationale should be explained in the requirements section in ``DOCUMENTATION``. In Ansible-2.3 the minimum requirement for modules was Python-2.4.
-* Modules must be written to use proper Python-3 syntax. At some point in the future we'll come up with rules for running on Python-3 but we're not there yet. See :doc:`developing_python3` for help on how to do this.
+* Modules must be written to use proper Python-3 syntax. At some point in the future we'll come up with rules for running on Python-3 but we're not there yet. See :doc:`developing_python_3` for help on how to do this.
* Modules must have a metadata section. For the vast majority of new modules,
the metadata should look exactly like this:
@@ -131,8 +131,8 @@ Read the complete :ref:`module metadata specification <ansible_metadata_block>`
module_utils.urls.fetch_url(). If you use those you may find you also want
to fallback on environment variables for default values. If you do that,
be sure to use non-generic environment variables (like
- :envvar:`API_<MODULENAME>_USERNAME`). Using generic environment variables
- like :envvar:`API_USERNAME` would conflict between modules.
+ :code:`API_<MODULENAME>_USERNAME`). Using generic environment variables
+ like :code:`API_USERNAME` would conflict between modules.
Windows modules checklist
=========================
diff --git a/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst b/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst
index 78d17b7f26..562ca2ec88 100644
--- a/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst
+++ b/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst
@@ -342,7 +342,7 @@ the most popular are
To be able to view the arguments as passed by Ansible to the module follow
these steps.
-- Prefix the Ansible command with :envvar:`ANSIBLE_KEEP_REMOTE_FILES=1` to specify that Ansible should keep the exec files on the server.
+- Prefix the Ansible command with :envvar:`ANSIBLE_KEEP_REMOTE_FILES=1<ANSIBLE_KEEP_REMOTE_FILES>` to specify that Ansible should keep the exec files on the server.
- Log onto the Windows server using the same user account that Ansible used to execute the module.
- Navigate to ``%TEMP%\..``. It should contain a folder starting with ``ansible-tmp-``.
- Inside this folder, open the PowerShell script for the module.
diff --git a/docs/docsite/rst/dev_guide/developing_python3.rst b/docs/docsite/rst/dev_guide/developing_python_3.rst
index 5fdd050f36..5fdd050f36 100644
--- a/docs/docsite/rst/dev_guide/developing_python3.rst
+++ b/docs/docsite/rst/dev_guide/developing_python_3.rst
diff --git a/docs/docsite/rst/dev_guide/index.rst b/docs/docsite/rst/dev_guide/index.rst
index ef37553dcc..7e37c218cd 100644
--- a/docs/docsite/rst/dev_guide/index.rst
+++ b/docs/docsite/rst/dev_guide/index.rst
@@ -19,7 +19,7 @@ To get started, select one of the following topics.
developing_plugins
developing_inventory
developing_core
- developing_python3
+ developing_python_3
developing_api
developing_rebasing
testing
diff --git a/docs/docsite/rst/plugins/connection.rst b/docs/docsite/rst/plugins/connection.rst
index 468ab4e37b..b06b987d5f 100644
--- a/docs/docsite/rst/plugins/connection.rst
+++ b/docs/docsite/rst/plugins/connection.rst
@@ -29,7 +29,7 @@ into the ``connection_plugins`` directory.
Using Connection Plugins
++++++++++++++++++++++++
-The transport can be changed via :ref:`configuration<ansible_configuration_settings>`, at the command line (``-c``, ``--connection``), as a :ref:`keyword <playbooks_keywords>` in your play, or by setting a :ref:`variable<behavioral_parameters>`, most often in your inventory.
+The transport can be changed via :ref:`configuration<ansible_configuration_settings>`, at the command line (``-c``, ``--connection``), as a :ref:`keyword <playbook_keywords>` in your play, or by setting a :ref:`variable<behavioral_parameters>`, most often in your inventory.
For example, for Windows machines you might want to use the :doc:`winrm<connection/winrm>` plugin.
Most connection plugins can operate with a minimum configuration. By default they use the :ref:`inventory hostname<inventory_hostnames_lookup>` and defaults to find the target host.
diff --git a/docs/docsite/rst/plugins/strategy.rst b/docs/docsite/rst/plugins/strategy.rst
index a3c2522af0..9aad8de8c8 100644
--- a/docs/docsite/rst/plugins/strategy.rst
+++ b/docs/docsite/rst/plugins/strategy.rst
@@ -34,7 +34,7 @@ or in the `ansible.cfg` file:
[defaults]
strategy=linear
-You can also specify the strategy plugin in the play via the :ref:`strategy keyword <playbooks_keywords>` in a play::
+You can also specify the strategy plugin in the play via the :ref:`strategy keyword <playbook_keywords>` in a play::
- hosts: all
strategy: debug
diff --git a/docs/docsite/rst/reference_appendices/faq.rst b/docs/docsite/rst/reference_appendices/faq.rst
index 7f74aa9964..146371d1f7 100644
--- a/docs/docsite/rst/reference_appendices/faq.rst
+++ b/docs/docsite/rst/reference_appendices/faq.rst
@@ -195,7 +195,7 @@ is likely the problem. There are several workarounds:
solaris1 ansible_remote_tmp=$HOME/.ansible/tmp
-* You can set :ref:`ansible_shell_executable` to the path to a POSIX compatible shell. For
+* You can set :ref:`ansible_shell_executable<ansible_shell_executable>` to the path to a POSIX compatible shell. For
instance, many Solaris hosts have a POSIX shell located at :file:`/usr/xpg4/bin/sh` so you can set
this in inventory like so::
diff --git a/docs/templates/playbooks_keywords.rst.j2 b/docs/templates/playbooks_keywords.rst.j2
index c16321e0c7..407491b42c 100644
--- a/docs/templates/playbooks_keywords.rst.j2
+++ b/docs/templates/playbooks_keywords.rst.j2
@@ -1,3 +1,5 @@
+.. _playbook_keywords:
+
Playbook Keywords
=================