IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added autosectionlabel_prefix_document config option.

Browse Source
This commit is contained in:
smheidrich
2017-02-04 01:23:16 +01:00
parent 680030b568
commit 231976ff14
5 changed files with 56 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/ext/autosectionlabel.rst
View File

@@ -22,4 +22,18 @@ For example::
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.
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.