diff options
author | Sandra McCann <samccann@redhat.com> | 2022-01-12 06:07:37 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-12 03:07:37 -0800 |
commit | 665e3dc629e9ec9a8612b2c144e0b94a22d7974a (patch) | |
tree | 3814c6ca30fd030b3f4cf4453a2b7200574a3ad8 | |
parent | b1ebc192b5f460b493a24bb7be5c9dd72a731b5c (diff) | |
download | ansible-665e3dc629e9ec9a8612b2c144e0b94a22d7974a.tar.gz |
remove outdated note on limitations of R() in module docs (#76736)
-rw-r--r-- | docs/docsite/rst/dev_guide/developing_modules_documenting.rst | 4 |
1 files changed, 0 insertions, 4 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index f620d35292..714d199b38 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -258,10 +258,6 @@ content in a uniform way: .. note:: - Cross-references with ``R()`` currently **do not work** inside option and return value documentations. They do work however in the global description, notes, and ``seealso`` descriptions. - -.. note:: - For links between modules and documentation within a collection, you can use any of the options above. For links outside of your collection, use ``R()`` if available. Otherwise, use ``U()`` or ``L()`` with full URLs (not relative links). For modules, use ``M()`` with the FQCN or ``ansible.builtin`` as shown in the example. If you are creating your own documentation site, you will need to use the `intersphinx extension <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_ to convert ``R()`` and ``M()`` to the correct links. .. note:: |