Fix internal option/return value links for simplified RST output.

Author: felixfontein

changelogs/fragments/269-refs.yml

@@ -1,3 +1,4 @@
 bugfixes:
   - "Fix links to requirements in simplified RST output (https://github.com/ansible-community/antsibull-docs/pull/269)."
+  - "Fix internal links to options and return values in simplified RST output (https://github.com/ansible-community/antsibull-docs/pull/269)."
   - "Include role in role attribute references (https://github.com/ansible-community/antsibull-docs/pull/269)."

src/antsibull_docs/markup/rstify.py

@@ -69,7 +69,7 @@ def plugin_option_like_link(
     ) -> t.Optional[str]:
         if current_plugin:
             ref = massage_rst_label("/".join(name))
-            ep = f"{entrypoint}__" if entrypoint is not None else ""
+            ep = f"{entrypoint}--" if entrypoint is not None else ""
             prefix = "return" if what == "retval" else "parameter"
             return f"{prefix}-{ep}{ref}_"
         return self.plugin_link(plugin)
@@ -83,7 +83,7 @@ def _custom_format_option_like(
     ) -> str:
         plugin = part.plugin
         if url and url.endswith("_"):
-            plugin_text = f" (`link <{url}>`_)"
+            plugin_text = f" (`link <#{url[:-1]}>`_)"
         elif plugin:
             plugin_result = [plugin.type]
             if plugin.type not in ("module", "role", "playbook"):

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_become.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo become -- Use foo \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo become -- Use foo \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This become plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cache.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo cache -- Foo files \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo cache -- Foo files \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This cache plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo callback -- Foo output \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo callback -- Foo output \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This callback plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_connection.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo connection -- Foo connection \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo connection -- Foo connection \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This connection plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo filter -- The foo filter \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo filter -- The foo filter \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This filter plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo inventory -- The foo inventory \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo inventory -- The foo inventory \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This inventory plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo lookup -- Look up some foo \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo lookup -- Look up some foo \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This lookup plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).

tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst

@@ -1,7 +1,7 @@
 
 .. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
 
-ns2.col.foo module -- Do some foo \ :literal:`bar` (`link <parameter-bar_>`_)\ 
+ns2.col.foo module -- Do some foo \ :literal:`bar` (`link <#parameter-bar>`_)\ 
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This module is part of the `ns2.col collection <https://galaxy.ansible.com/ui/repo/published/ns2/col/>`_ (version 2.1.0).
@@ -199,7 +199,7 @@ See Also
   Another foo.
 * \ `ns2.col.foo <foo_lookup.rst>`__\  lookup plugin
 
-  Look up some foo \ :literal:`bar` (`link <parameter-bar_>`_)\ .
+  Look up some foo \ :literal:`bar` (`link <#parameter-bar>`_)\ .
 * \ `ansible.builtin.service <service_module.rst>`__\ 
 
   The service module.