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

Add markup and clarify numfig_secnum_depth docs

Browse Source
This commit is contained in:
jfbu
2017-12-16 11:05:33 +01:00
parent 7cabd6cbb0
commit 070fbb97e5
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/config.rst
View File

@@ -311,8 +311,8 @@ General configuration
.. confval:: numfig
If true, figures, tables and code-blocks are automatically numbered if they
have a caption. At same time, the `numref` role is enabled. For now, it
works only with the HTML builder and LaTeX builder. Default is ``False``.
have a caption. The :rst:role:`numref` role is enabled.
Obeyed so far only by HTML and LaTeX builders. Default is ``False``.
.. note::
@@ -335,10 +335,12 @@ General configuration
.. confval:: numfig_secnum_depth
The scope of figure numbers, that is, the numfig feature numbers figures
in which scope. ``0`` means "whole document". ``1`` means "in a section".
Sphinx numbers like x.1, x.2, x.3... ``2`` means "in a subsection". Sphinx
numbers like x.x.1, x.x.2, x.x.3..., and so on. Default is ``1``.
The scope for numbering: ``0`` means "continuous numbering",
``1`` means "reset per section"
(i.e. numbers will be x.1, x.2, x.3 ... with x the section number),
``2`` means "per subsection"
(i.e. numbers will be x.y.1, x.y.2, ...),
and so on. Default is ``1``.
.. versionadded:: 1.3