Skip to content

Docs: remove some lies from cross referencing guide #8173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 11, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/guides/cross-referencing-with-sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@ Another example, here we add a target to a paragraph:
Then we can reference it using ```target to paragraph`_``,
that will be rendered as: `target to paragraph`_.

The reference displays the name of the target by default,
but we can use any text you want. For example:
```my custom text <target to paragraph>`_``,
that will be rendered as: `my custom text <target to paragraph>`_.

We can also create _`in-line targets` within an element on your page,
allowing you to, for example, reference text *within* a paragraph.

Expand Down Expand Up @@ -129,7 +124,7 @@ Next, we will explore the most common ones.
The ref role
~~~~~~~~~~~~

The ``ref`` role can be used to reference any explicit target. For example:
The ``ref`` role can be used to reference any explicit targets. For example:

.. code-block:: rst

Expand Down Expand Up @@ -165,7 +160,7 @@ that will be rendered as: :ref:`code <target to code>`.
The doc role
~~~~~~~~~~~~

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

Expand Down