Skip to content

Commit 5f5ee22

Browse files
authored
Docs: remove some lies from cross referencing guide (#8173)
1 parent 91a17f6 commit 5f5ee22

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

docs/guides/cross-referencing-with-sphinx.rst

+2-7
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,6 @@ Another example, here we add a target to a paragraph:
7777
Then we can reference it using ```target to paragraph`_``,
7878
that will be rendered as: `target to paragraph`_.
7979

80-
The reference displays the name of the target by default,
81-
but we can use any text you want. For example:
82-
```my custom text <target to paragraph>`_``,
83-
that will be rendered as: `my custom text <target to paragraph>`_.
84-
8580
We can also create _`in-line targets` within an element on your page,
8681
allowing you to, for example, reference text *within* a paragraph.
8782

@@ -129,7 +124,7 @@ Next, we will explore the most common ones.
129124
The ref role
130125
~~~~~~~~~~~~
131126

132-
The ``ref`` role can be used to reference any explicit target. For example:
127+
The ``ref`` role can be used to reference any explicit targets. For example:
133128

134129
.. code-block:: rst
135130
@@ -165,7 +160,7 @@ that will be rendered as: :ref:`code <target to code>`.
165160
The doc role
166161
~~~~~~~~~~~~
167162

168-
The `doc` role allows us to link to a page instead of just a section.
163+
The ``doc`` role allows us to link to a page instead of just a section.
169164
The target name can be relative to the page where the role exists, or relative
170165
to your documentation's root folder (in both cases, you should omit the extension).
171166

0 commit comments

Comments
 (0)