diff options
author | tk0miya <i.tkomiya@gmail.com> | 2014-10-08 11:03:14 +0900 |
---|---|---|
committer | tk0miya <i.tkomiya@gmail.com> | 2014-10-08 11:03:14 +0900 |
commit | 6d265c593fe5ccda1e285dd89a5d09178c7ef48a (patch) | |
tree | dff18cc98311f77c7b8348e2b47c9aa05db63f78 | |
parent | 6e2e4d12b96413b460ec01dc9c5d90519ce8d079 (diff) | |
download | sphinx-6d265c593fe5ccda1e285dd89a5d09178c7ef48a.tar.gz |
Add docs about confval for numfig
-rw-r--r-- | doc/config.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst index f181e5c5..654dec01 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -231,6 +231,28 @@ General configuration .. versionadded:: 1.1 +.. confval:: numfig + + If true, figures, tables and code-blocks are automatically numbered if they + has caption. Works only for the HTML builder currently. Default is ``False``. + +.. confval:: numfig_prefix + + A dictionary mapping ``'figure'``, ``'table'`` and ``'code-block'`` to + strings that are used for prefix of figure numbers. Default is to use + ``'Fig. %s'`` for ``'figure'``, ``'Table %s'`` for ``'table'`` and + ``'Listing %s'`` for ``'code-block'``. + + .. versionadded:: 1.3 + +.. 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``. + + .. versionadded:: 1.3 Project information ------------------- |