doc: Fix ambiguous confval entries and references

This commit is contained in:
Takeshi KOMIYA committed 2019-12-29 23:23:46 +09:00
1 parent c358e04b09
commit 7851550cd8
3 files changed
+20 -17

No files matched your search

+2 -2
View File
@@ -1975,7 +1975,7 @@ Features removed
* ``termsep`` node
* defindex.html template
* LDML format support in `today`, `today_fmt` and `html_last_updated_fmt`
* LDML format support in ``today``, ``today_fmt`` and ``html_last_updated_fmt``
* ``:inline:`` option for the directives of sphinx.ext.graphviz extension
* sphinx.ext.pngmath extension
* ``sphinx.util.compat.make_admonition()``
@@ -4779,7 +4779,7 @@ Features added
- Added a "nitpicky" mode that emits warnings for all missing
references. It is activated by the :option:`sphinx-build -n` command-line
switch or the `nitpicky` config value.
switch or the :confval:`nitpicky` config value.
- Added ``latexpdf`` target in quickstart Makefile.
* Markup:
+3
View File
@@ -146,6 +146,9 @@ def setup(app):
app.add_object_type('confval', 'confval',
objname='configuration value',
indextemplate='pair: %s; configuration value')
app.add_object_type('setuptools-confval', 'setuptools-confval',
objname='setuptools configuration value',
indextemplate='pair: %s; setuptools configuration value')
fdesc = GroupedField('parameter', label='Parameters',
names=['param'], can_collapse=True)
app.add_object_type('event', 'event', 'pair: %s; event', parse_event,
+15 -15
View File
@@ -57,7 +57,7 @@ Once configured, call this by calling the relevant command on ``setup.py``::
Options for setuptools integration
----------------------------------
.. confval:: fresh-env
.. setuptools-confval:: fresh-env
A boolean that determines whether the saved environment should be discarded
on build. Default is false.
@@ -68,7 +68,7 @@ Options for setuptools integration
$ python setup.py build_sphinx -E
.. confval:: all-files
.. setuptools-confval:: all-files
A boolean that determines whether all files should be built from scratch.
Default is false.
@@ -79,7 +79,7 @@ Options for setuptools integration
$ python setup.py build_sphinx -a
.. confval:: source-dir
.. setuptools-confval:: source-dir
The target source directory. This can be relative to the ``setup.py`` or
``setup.cfg`` file, or it can be absolute. It defaults to ``./doc`` or
@@ -92,12 +92,12 @@ Options for setuptools integration
$ python setup.py build_sphinx -s $SOURCE_DIR
.. confval:: build-dir
.. setuptools-confval:: build-dir
The target build directory. This can be relative to the ``setup.py`` or
``setup.cfg`` file, or it can be absolute. Default is ``./build/sphinx``.
.. confval:: config-dir
.. setuptools-confval:: config-dir
Location of the configuration directory. This can be relative to the
``setup.py`` or ``setup.cfg`` file, or it can be absolute. Default is to use
@@ -111,7 +111,7 @@ Options for setuptools integration
.. versionadded:: 1.0
.. confval:: builder
.. setuptools-confval:: builder
The builder or list of builders to use. Default is ``html``.
@@ -124,7 +124,7 @@ Options for setuptools integration
.. versionchanged:: 1.6
This can now be a comma- or space-separated list of builders
.. confval:: warning-is-error
.. setuptools-confval:: warning-is-error
A boolean that ensures Sphinx warnings will result in a failed build.
Default is false.
@@ -137,32 +137,32 @@ Options for setuptools integration
.. versionadded:: 1.5
.. confval:: project
.. setuptools-confval:: project
The documented project's name. Default is ``''``.
.. versionadded:: 1.0
.. confval:: version
.. setuptools-confval:: version
The short X.Y version. Default is ``''``.
.. versionadded:: 1.0
.. confval:: release
.. setuptools-confval:: release
The full version, including alpha/beta/rc tags. Default is ``''``.
.. versionadded:: 1.0
.. confval:: today
.. setuptools-confval:: today
How to format the current date, used as the replacement for ``|today|``.
Default is ``''``.
.. versionadded:: 1.0
.. confval:: link-index
.. setuptools-confval:: link-index
A boolean that ensures index.html will be linked to the master doc. Default
is false.
@@ -175,13 +175,13 @@ Options for setuptools integration
.. versionadded:: 1.0
.. confval:: copyright
.. setuptools-confval:: copyright
The copyright string. Default is ``''``.
.. versionadded:: 1.3
.. confval:: nitpicky
.. setuptools-confval:: nitpicky
Run in nit-picky mode. Currently, this generates warnings for all missing
references. See the config value :confval:`nitpick_ignore` for a way to
@@ -189,7 +189,7 @@ Options for setuptools integration
.. versionadded:: 1.8
.. confval:: pdb
.. setuptools-confval:: pdb
A boolean to configure ``pdb`` on exception. Default is false.