Skip to content

Commit c92aeed

Browse files
committed
fixed ref
1 parent 07b000d commit c92aeed

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/docsite/rst/dev_guide/ansible_index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Find the task that best describes what you want to do:
4646
* I want to :ref:`debug my module code <debugging_modules>`.
4747
* I want to :ref:`add tests <developing_testing>`.
4848
* I want to :ref:`document my module <module_documenting>`.
49-
* I want to :ref:`document my plugin <plugin_documenting>`.
49+
* I want to :ref:`document my plugin <plugins_documenting>`.
5050
* I want to :ref:`document my set of modules for a network platform <documenting_modules_network>`.
5151
* I want to follow :ref:`conventions and tips for clean, usable module code <developing_modules_best_practices>`.
5252
* I want to :ref:`make sure my code runs on Python 2 and Python 3 <developing_python_3>`.

docs/docsite/rst/dev_guide/core_index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Find the task that best describes what you want to do:
4343
* I want to :ref:`debug my module code <debugging_modules>`.
4444
* I want to :ref:`add tests <developing_testing>`.
4545
* I want to :ref:`document my module <module_documenting>`.
46-
* I want to :ref:`document my plugin <plugin_documenting>`.
46+
* I want to :ref:`document my plugin <plugins_documenting>`.
4747
* I want to :ref:`document my set of modules for a network platform <documenting_modules_network>`.
4848
* I want to follow :ref:`conventions and tips for clean, usable module code <developing_modules_best_practices>`.
4949
* I want to :ref:`make sure my code runs on Python 2 and Python 3 <developing_python_3>`.

docs/docsite/rst/dev_guide/developing_collections_documenting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Documenting collections
77
Documenting modules and plugins
88
===============================
99

10-
Documenting modules is thoroughly documented in :ref:`module_documenting`. Plugins can be documented in a similar way to modules :ref:`plugin_documenting`, that is with ``DOCUMENTATION``, ``EXAMPLES``, and ``RETURN`` blocks.
10+
Documenting modules is thoroughly documented in :ref:`module_documenting`. Plugins can be documented in a similar way to modules :ref:`plugins_documenting`, that is with ``DOCUMENTATION``, ``EXAMPLES``, and ``RETURN`` blocks.
1111

1212
Documenting roles
1313
=================

docs/docsite/rst/dev_guide/developing_plugins.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ If you need to populate settings explicitly, use a ``self.set_options()`` call.
8989

9090
Configuration sources follow the precedence rules for values in Ansible. When there are multiple values from the same category, the value defined last takes precedence. For example, in the above configuration block, if both ``name_of_ansible_var`` and ``name_of_second_var`` are defined, the value of the ``option_name`` option will be the value of ``name_of_second_var``. Refer to :ref:`general_precedence_rules` for further information.
9191

92-
Plugins that support embedded documentation (see :ref:`ansible-doc` for the list) should include well-formed doc strings. If you inherit from a plugin, you must document the options it takes, either through a documentation fragment or as a copy. See :ref:`plugin_documenting` for more information on correct documentation. Thorough documentation is a good idea even if you're developing a plugin for local use.
92+
Plugins that support embedded documentation (see :ref:`ansible-doc` for the list) should include well-formed doc strings. If you inherit from a plugin, you must document the options it takes, either through a documentation fragment or as a copy. See :ref:`plugins_documenting` for more information on correct documentation. Thorough documentation is a good idea even if you're developing a plugin for local use.
9393

9494
In ansible-core 2.14 we added support for documenting filter and test plugins. You have two options for providing documentation:
9595
- Define a Python file that includes inline documentation for each plugin.

0 commit comments

Comments
 (0)