File tree Expand file tree Collapse file tree 1 file changed +15
-12
lines changed Expand file tree Collapse file tree 1 file changed +15
-12
lines changed Original file line number Diff line number Diff line change 11# sphinx-hoverxref - preview cross-references
22
3- Using sphinx-hoverxref, we can preview cross-references in the documentation.
3+ Using ` sphinx-hoverxref ` , we can preview cross-references in the documentation.
44
55For instance, try placing your mouse over {hoverxref}` this reference to the front page <intro> ` .
6- We have used a named "target" for the reference. Here are some examples of how to name your targets:
6+ We have use a named "target" for the reference. Here are some examples of how to name your targets:
7+
8+ ``` {tab} MyST (Markdown)
9+
10+ ```markdown
11+
12+ (foobar)=
13+
14+ # My Headline
15+
16+ Here is a paragraph, we link to this headline {hoverxref}`like this <foobar>`.
17+ ```
718
819``` {tab} reStructuredText
920
@@ -16,13 +27,5 @@ My Headline
1627Here is a paragraph, we link to this headline :hoverxref:`like this <foobar>`
1728```
1829
19- ``` {tab} MyST
20-
21- ```markdown
22-
23- (foobar)=
24-
25- # My Headline
26-
27- Here is a paragraph, we link to this headline {hoverxref}`like this <foobar>`.
28- ```
30+ ` sphinx-hoverxref ` works especially well on Read the Docs, since the platform runs the necessary API backend for generating preview data.
31+ Aside from enabling the extention in your project's ` _config.yml ` , you don't have to do anyhing, it Just Works™️.
You can’t perform that action at this time.
0 commit comments