Skip to content

Commit a63d77f

Browse files
felixfonteinfelixfontein
committed
Fix internal option/return value links for simplified RST output.
1 parent 6ec5b11 commit a63d77f

28 files changed

+32
-31
lines changed

‎changelogs/fragments/269-refs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
bugfixes:
2+
- "Fix internal links to options and return values in simplified RST output (https://github.com/ansible-community/antsibull-docs/pull/269)."
23
- "Include role in role attribute references (https://github.com/ansible-community/antsibull-docs/pull/269)."

‎src/antsibull_docs/markup/rstify.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def plugin_option_like_link(
6969
) -> t.Optional[str]:
7070
if current_plugin:
7171
ref = massage_rst_label("/".join(name))
72-
ep = f"{entrypoint}__" if entrypoint is not None else ""
72+
ep = f"{entrypoint}--" if entrypoint is not None else ""
7373
prefix = "return" if what == "retval" else "parameter"
7474
return f"{prefix}-{ep}{ref}_"
7575
return self.plugin_link(plugin)
@@ -83,7 +83,7 @@ def _custom_format_option_like(
8383
) -> str:
8484
plugin = part.plugin
8585
if url and url.endswith("_"):
86-
plugin_text = f" (`link <{url}>`_)"
86+
plugin_text = f" (`link <#{url[:-1]}>`_)"
8787
elif plugin:
8888
plugin_result = [plugin.type]
8989
if plugin.type not in ("module", "role", "playbook"):

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo become -- Use foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo become -- Use foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo cache -- Foo files \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo cache -- Foo files \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo callback -- Foo output \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo callback -- Foo output \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo connection -- Foo connection \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo connection -- Foo connection \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo filter -- The foo filter \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo filter -- The foo filter \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo inventory -- The foo inventory \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo inventory -- The foo inventory \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo lookup -- Look up some foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo lookup -- Look up some foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo module -- Do some foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo module -- Do some foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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
199199
Another foo.
200200
* \ `ns2.col.foo <foo_lookup.rst>`__\ lookup plugin
201201

202-
Look up some foo \ :literal:`bar` (`link <parameter-bar_>`_)\ .
202+
Look up some foo \ :literal:`bar` (`link <#parameter-bar>`_)\ .
203203
* \ `ansible.builtin.service <service_module.rst>`__\
204204

205205
The service module.

‎tests/functional/baseline-simplified-rst-squash-hierarchy/foo_role.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Synopsis
3939
^^^^^^^^
4040

4141
- This is the foo role.
42-
- If you set \ :literal:`foo\_param\_1` (`link <parameter-main__foo_param_1_>`_)\ while \ :literal:`foo\_param\_2=3` (`link <parameter-main__foo_param_2_>`_)\ , this might behave funny.
42+
- If you set \ :literal:`foo\_param\_1` (`link <#parameter-main--foo_param_1>`_)\ while \ :literal:`foo\_param\_2=3` (`link <#parameter-main--foo_param_2>`_)\ , this might behave funny.
4343

4444

4545
Parameters

‎tests/functional/baseline-simplified-rst-squash-hierarchy/foo_shell.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo shell -- Foo shell \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo shell -- Foo shell \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
This shell 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_test.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo test -- Is something a foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo test -- Is something a foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
This test 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_vars.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo vars -- Load foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo vars -- Load foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
This vars 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/collections/ns/col2/foo2_module.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Synopsis
2626

2727
- Does some foo on the remote host.
2828
- A broken reference \ :ref:`asdfasdfoobarTHISDOESNOTEXIST <asdfasdfoobarTHISDOESNOTEXIST>`\ .
29-
- The option \ :literal:`foo` (`link <parameter-foo_>`_)\ exists, but \ :literal:`foobar` (`link <parameter-foobar_>`_)\ does not.
30-
- The return value \ :literal:`bar` (`link <return-bar_>`_)\ exists, but \ :literal:`barbaz` (`link <return-barbaz_>`_)\ does not.
29+
- The option \ :literal:`foo` (`link <#parameter-foo>`_)\ exists, but \ :literal:`foobar` (`link <#parameter-foobar>`_)\ does not.
30+
- The return value \ :literal:`bar` (`link <#return-bar>`_)\ exists, but \ :literal:`barbaz` (`link <#return-barbaz>`_)\ does not.
3131
- Again existing: \ :literal:`foo=1` (of module `ns.col2.foo <foo_module.rst>`__)\ , \ :literal:`bar=2` (of module `ns.col2.foo <foo_module.rst>`__)\
3232
- Again not existing: \ :literal:`foobar=1` (of module `ns.col2.foo <foo_module.rst>`__)\ , \ :literal:`barbaz=2` (of module `ns.col2.foo <foo_module.rst>`__)\
3333

‎tests/functional/baseline-simplified-rst/collections/ns2/col/foo_become.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo become -- Use foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo become -- Use foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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/collections/ns2/col/foo_cache.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo cache -- Foo files \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo cache -- Foo files \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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/collections/ns2/col/foo_callback.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo callback -- Foo output \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo callback -- Foo output \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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/collections/ns2/col/foo_connection.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo connection -- Foo connection \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo connection -- Foo connection \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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/collections/ns2/col/foo_filter.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo filter -- The foo filter \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo filter -- The foo filter \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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/collections/ns2/col/foo_inventory.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo inventory -- The foo inventory \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo inventory -- The foo inventory \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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/collections/ns2/col/foo_lookup.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo lookup -- Look up some foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo lookup -- Look up some foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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/collections/ns2/col/foo_module.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo module -- Do some foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo module -- Do some foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
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
199199
Another foo.
200200
* \ `ns2.col.foo <foo_lookup.rst>`__\ lookup plugin
201201

202-
Look up some foo \ :literal:`bar` (`link <parameter-bar_>`_)\ .
202+
Look up some foo \ :literal:`bar` (`link <#parameter-bar>`_)\ .
203203
* \ `ansible.builtin.service <service_module.rst>`__\
204204

205205
The service module.

‎tests/functional/baseline-simplified-rst/collections/ns2/col/foo_role.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Synopsis
3939
^^^^^^^^
4040

4141
- This is the foo role.
42-
- If you set \ :literal:`foo\_param\_1` (`link <parameter-main__foo_param_1_>`_)\ while \ :literal:`foo\_param\_2=3` (`link <parameter-main__foo_param_2_>`_)\ , this might behave funny.
42+
- If you set \ :literal:`foo\_param\_1` (`link <#parameter-main--foo_param_1>`_)\ while \ :literal:`foo\_param\_2=3` (`link <#parameter-main--foo_param_2>`_)\ , this might behave funny.
4343

4444

4545
Parameters

‎tests/functional/baseline-simplified-rst/collections/ns2/col/foo_shell.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo shell -- Foo shell \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo shell -- Foo shell \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
This shell 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/collections/ns2/col/foo_test.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo test -- Is something a foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo test -- Is something a foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
This test 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/collections/ns2/col/foo_vars.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.col.foo vars -- Load foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.col.foo vars -- Load foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
This vars 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/collections/ns2/flatcol/foo_module.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
.. Created with antsibull-docs <ANTSIBULL_DOCS_VERSION>
33
4-
ns2.flatcol.foo module -- Do some foo \ :literal:`bar` (`link <parameter-bar_>`_)\
4+
ns2.flatcol.foo module -- Do some foo \ :literal:`bar` (`link <#parameter-bar>`_)\
55
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66

77
This module is part of the `ns2.flatcol collection <https://galaxy.ansible.com/ui/repo/published/ns2/flatcol/>`_.

0 commit comments

Comments
 (0)