You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
.. |thing| replace:: *The Thing*
.. _thing: `thing-code`_
.. literalinclude:: code.py:language: python
:caption: Code about |thing|
:name: thing-code
See |thing|_.
Sphinx will correctly produce a "See The Thing.", where the link would anchor to the literal code. Note that this indirect link referencing is needed to add the style (italic) and alternate text simultaneously, since :ref: does not permit styling. In this specific case, it is also needed to avoid injecting the full caption (i.e.: Code about The Thing) each time a reference to |thing|_ is needed in the text.
However, doc8 will report something along the lines of:
D000 Indirect hyperlink target "thing" (id="thing") refers to target "thing-code", which does not exist.
This is a false positive from doc8, since this kind of resolution is supported.
This example only shows literalinclude, but there are many RST directives that provide similar :name: fields to allow cross-referencing.
The text was updated successfully, but these errors were encountered:
Using the following combination:
Sphinx will correctly produce a "See The Thing.", where the link would anchor to the literal code. Note that this indirect link referencing is needed to add the style (italic) and alternate text simultaneously, since
:ref:
does not permit styling. In this specific case, it is also needed to avoid injecting the full caption (i.e.:Code about The Thing
) each time a reference to|thing|_
is needed in the text.However,
doc8
will report something along the lines of:This is a false positive from
doc8
, since this kind of resolution is supported.This example only shows
literalinclude
, but there are many RST directives that provide similar:name:
fields to allow cross-referencing.The text was updated successfully, but these errors were encountered: