IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix #3118: Update document for numfig_format and numref

Browse Source
This commit is contained in:
Takeshi KOMIYA
2016-11-20 12:46:30 +09:00
parent b84035416f
commit 7c19a2f36a
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/config.rst
+1 -5
View File
@@ -297,8 +297,7 @@ General configuration
A dictionary mapping ``'figure'``, ``'table'``, ``'code-block'`` and A dictionary mapping ``'figure'``, ``'table'``, ``'code-block'`` and
``'section'`` to strings that are used for format of figure numbers. ``'section'`` to strings that are used for format of figure numbers.
As a special character, `%s` and `{number}` will be replaced to figure As a special character, `%s` will be replaced to figure number.
number. `{name}` will be replaced to figure caption.
Default is to use ``'Fig. %s'`` for ``'figure'``, ``'Table %s'`` for Default is to use ``'Fig. %s'`` for ``'figure'``, ``'Table %s'`` for
``'table'``, ``'Listing %s'`` for ``'code-block'`` and ``'Section'`` for ``'table'``, ``'Listing %s'`` for ``'code-block'`` and ``'Section'`` for
@@ -306,9 +305,6 @@ General configuration
.. versionadded:: 1.3 .. versionadded:: 1.3
.. versionchanged:: 1.5
Support format of section. Allow to refer the caption of figures.
.. confval:: numfig_secnum_depth .. confval:: numfig_secnum_depth
The scope of figure numbers, that is, the numfig feature numbers figures The scope of figure numbers, that is, the numfig feature numbers figures
doc/markup/inline.rst
+5 -1
View File
@@ -214,6 +214,7 @@ Cross-referencing figures by figure number
.. versionchanged:: 1.5 .. versionchanged:: 1.5
`numref` role can also refer sections. `numref` role can also refer sections.
And `numref` allows `{name}` for the link text.
.. rst:role:: numref .. rst:role:: numref
@@ -223,7 +224,10 @@ Cross-referencing figures by figure number
If an explicit link text is given (like usual: ``:numref:`Image of Sphinx (Fig. If an explicit link text is given (like usual: ``:numref:`Image of Sphinx (Fig.
%s) <my-figure>```), the link caption will be the title of the reference. %s) <my-figure>```), the link caption will be the title of the reference.
The format of link text is same as :confval:`numfig_format`. As a special character, `%s` and `{number}` will be replaced to figure
number. `{name}` will be replaced to figure caption.
If no explicit link text is given, the value of :confval:`numfig_format` is
used to default value of link text.
If :confval:`numfig` is ``False``, figures are not numbered. If :confval:`numfig` is ``False``, figures are not numbered.
so this role inserts not a reference but labels or link text. so this role inserts not a reference but labels or link text.