mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
41 lines
1.2 KiB
ReStructuredText
41 lines
1.2 KiB
ReStructuredText
.. highlight:: rest
|
|
|
|
:mod:`sphinx.ext.autosectionlabel` -- Allow reference sections using its title
|
|
==============================================================================
|
|
|
|
.. module:: sphinx.ext.autosectionlabel
|
|
:synopsis: Allow reference section its title.
|
|
|
|
.. versionadded:: 1.4
|
|
|
|
This extension allows you to refer sections its title. This affects to the
|
|
reference role (:rst:role:`ref`).
|
|
|
|
For example::
|
|
|
|
A Plain Title
|
|
-------------
|
|
|
|
This is the text of the section.
|
|
|
|
It refers to the section title, see :ref:`A Plain Title`.
|
|
|
|
|
|
Internally, this extension generates the labels for each section. If same
|
|
section names are used in whole of document, any one is used for a target by
|
|
default. The ``autosectionlabel_prefix_document`` configuration variable can be
|
|
used to make headings which appear multiple times but in different documents
|
|
unique.
|
|
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
.. confval:: autosectionlabel_prefix_document
|
|
|
|
True to prefix each section label with the name of the document it is in,
|
|
followed by a colon. For example, ``index:Introduction`` for a section
|
|
called ``Introduction`` that appears in document ``index.rst``. Useful for
|
|
avoiding ambiguity when the same section heading appears in different
|
|
documents.
|