@@ -14,7 +14,7 @@ This works, but it has some disadvantages:
14
14
- There is no easy way to link to specific sections like paragraphs, figures, or code blocks.
15
15
- URL links only work for the html version of your documentation.
16
16
17
- ReStructuredText has a built-in way to linking to elements,
17
+ reStructuredText has a built-in way to linking to elements,
18
18
and Sphinx extends this to make it even more powerful!
19
19
Some advantages of using reStructuredText's references:
20
20
@@ -43,13 +43,13 @@ Explicit targets
43
43
If you are not familiar with reStructuredText,
44
44
check :doc: `sphinx:usage/restructuredtext/basics ` for a quick introduction.
45
45
46
- Cross referencing in Sphinx uses two components, **targets ** and **references **.
46
+ Cross referencing in Sphinx uses two components, **references ** and **targets **.
47
47
48
48
- **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 .
50
50
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 **.
53
53
54
54
For example, one way of creating an explicit target for a section is:
55
55
@@ -124,7 +124,7 @@ Sphinx provides some roles that allows us to reference any explicit target from
124
124
all targets must be unique.
125
125
126
126
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.
128
128
129
129
The ref role
130
130
~~~~~~~~~~~~
@@ -286,8 +286,8 @@ List all targets for built documentation with:
286
286
287
287
python -m sphinx.ext.intersphinx <link>
288
288
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 ``).
291
291
For example, to see all targets from the Read the Docs documentation:
292
292
293
293
.. prompt :: bash
0 commit comments