Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 1.98 KB

referencing.rst

File metadata and controls

74 lines (51 loc) · 1.98 KB
topic

Referencing

triple: Sphinx; Syntax; Referencing

Referencing

Another important feature is that it allows referencing across documents. This is another powerful way to tie documents together.

The simplest way to do this is to define an explicit reference object which can then be referenced directly as internal hyperlink target or with :ref:`refname or in rare cases with :rst:refname depending on the :rst:dir:`sphinx:toctree section numbering setup. also supports :doc:`docname for linking to a document via built-in extension :py:mod:`sphinx:sphinx.ext.intersphinx and also supports auto-generated labels for each section via built-in extension :pysphinx:sphinx.ext.autosectionlabel.

The Hyperlink Targets <hyperlinks> in provides the basic specification for internal <internal-hyperlink-targets> and external <external-hyperlink-targets> hyperlink targets. These are also called explicit <explicit-hyperlink-targets> and also available as implicit <implicit-hyperlink-targets> hyperlink targets.

centered

A cool section

centered

The hyperlink target above points to this paragraph.