From 18051a5110aa0a5187539c8e3e950f13cfd87559 Mon Sep 17 00:00:00 2001 From: tk0miya Date: Wed, 8 Oct 2014 11:03:14 +0900 Subject: [PATCH] Add docs about confval for numfig --- doc/config.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/config.rst b/doc/config.rst index f181e5c52..654dec010 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 -------------------