mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix #8054: Add explanation for types argument of add_config_value()
This commit is contained in:
parent
f707cb30a1
commit
f873a5890f
@ -499,6 +499,10 @@ class Sphinx:
|
|||||||
documents.
|
documents.
|
||||||
* ``''`` if a change in the setting will not need any special rebuild.
|
* ``''`` if a change in the setting will not need any special rebuild.
|
||||||
|
|
||||||
|
The *types* value takes a list of types that describes the type of
|
||||||
|
configuration value. For example, ``[str]`` is used to describe a
|
||||||
|
configuration that takes string value.
|
||||||
|
|
||||||
.. versionchanged:: 0.6
|
.. versionchanged:: 0.6
|
||||||
Changed *rebuild* from a simple boolean (equivalent to ``''`` or
|
Changed *rebuild* from a simple boolean (equivalent to ``''`` or
|
||||||
``'env'``) to a string. However, booleans are still accepted and
|
``'env'``) to a string. However, booleans are still accepted and
|
||||||
|
Loading…
Reference in New Issue
Block a user