Skip to content

Commit 2cbabc8

Browse files
stsewdhumitos
andauthored
Apply suggestions from code review
Co-authored-by: Manuel Kaufmann <[email protected]>
1 parent 95e3cdd commit 2cbabc8

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This works, but it has some disadvantages:
1414
- There is no easy way to link to specific sections like paragraphs, figures, or code blocks.
1515
- URL links only work for the html version of your documentation.
1616

17-
ReStructuredText has a built-in way to linking to elements,
17+
reStructuredText has a built-in way to linking to elements,
1818
and Sphinx extends this to make it even more powerful!
1919
Some advantages of using reStructuredText's references:
2020

@@ -43,13 +43,13 @@ Explicit targets
4343
If you are not familiar with reStructuredText,
4444
check :doc:`sphinx:usage/restructuredtext/basics` for a quick introduction.
4545

46-
Cross referencing in Sphinx uses two components, **targets** and **references**.
46+
Cross referencing in Sphinx uses two components, **references** and **targets**.
4747

4848
- **references** are pointers in your documentation to other parts of your documentation.
49-
- **targets** are the where references can point.
49+
- **targets** are where the references can point to.
5050

51-
You can manually create a target in any location of your documentation, allowing
52-
you to reference it from other pages. These are called **explicit targets**.
51+
You can manually create a *target* in any location of your documentation, allowing
52+
you to *reference* it from other pages. These are called **explicit targets**.
5353

5454
For example, one way of creating an explicit target for a section is:
5555

@@ -124,7 +124,7 @@ Sphinx provides some roles that allows us to reference any explicit target from
124124
all targets must be unique.
125125

126126
You can see the complete list of cross-referencing roles at :ref:`sphinx:xref-syntax`.
127-
Next we will explore the most common ones.
127+
Next, we will explore the most common ones.
128128

129129
The ref role
130130
~~~~~~~~~~~~
@@ -286,8 +286,8 @@ List all targets for built documentation with:
286286

287287
python -m sphinx.ext.intersphinx <link>
288288

289-
Where the link is either a URL or a local path that points to your inventory file
290-
(``usually in _build/html/objects.inv``).
289+
Where the ``<link>`` is either a URL or a local path that points to your inventory file
290+
(usually in ``_build/html/objects.inv``).
291291
For example, to see all targets from the Read the Docs documentation:
292292

293293
.. prompt:: bash

0 commit comments

Comments
 (0)