Links

External Links

External links can be:

• bare (URL in the body)
• direct (`LABEL <URL>`_)
• indirect (defined by .. _LABEL: URL , referenced by `LABEL`_).

Source:

*  Bare link: http://www.example.com/

*  Link with direct reference: This is a `direct reference <http://www.example.com/direct>`_.

*  Link with indirect reference: This is an `indirect reference`_

.. _indirect reference: http://www.example.com/indirect

Result:

• Bare link: http://www.example.com/
• Link with direct reference: This is a direct reference.
• Link with indirect reference: This is an indirect reference

References:

• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-targets
• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-references
• https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks

Internal Links

Section headings are named by preceding them with .. _LLL: (note the underscore), and referenced with :ref:`LLL` (note the absence of leading or trailing underscore).

Source:

For more information, see :ref:`fakesection`.

.. _fakesection:

Fake Section
------------

This is a fake section.

Result:

For more information, see Fake Section.

Fake Section

This is a fake section.

References:

• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-targets
• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#inline-internal-targets
• https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role

Footnotes

Footnotes are defined with .. [#LLL] and referenced with [#LLL]_ (compare both with the lack of # in citations).

Source:

This is a reference to a footnote labeled f1 [#f1]_ . This is also a reference to f1 [#f1]_ .

.. rubric:: Footnotes

.. [#f1]

   Body of footnote f1.

   If the body fits on one line, can be on the same line as ``..``.

Result:

This is a reference to a footnote labeled f1 [1] . This is also a reference to f1 [1] .

Footnotes

[1]	(1, 2) Body of footnote f1. If the body fits on one line, can be on the same line as ...

References:

• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#footnotes
• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#footnote-references
• https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes

Citations

LaTeX-style, single-keyword citations are defined with .. [LLL] and referenced with [LLL]_ (compare both with the # in footnotes).

Source:

LaTeX-style citations are supported [RFC2119]_ .

.. rubric:: Citations

.. [RFC2119]

   Body of ``RFC2119`` citation: https://tools.ietf.org/rfc/rfc2119.txt

   If the body fits on one line, can be on the same line as ``..``.

Result:

LaTeX-style citations are supported [RFC2119] .

Citations

[RFC2119]

Body of RFC2119 citation: https://tools.ietf.org/rfc/rfc2119.txt If the body fits on one line, can be on the same line as ...

Tip

Standard reStructuredText citations are per-file, but Sphinx makes citations global.

In local PDF output, citations are grouped together into a Bibliography appendix. In HTML output, citations are rendered wherever they are defined. This makes the toy example above impractical as a single source for both HTML and PDF.

References:

• https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations

References:

• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#citations
• https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#citation-references
• https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations