Fix #8054: Add explanation for types argument of add_config_value()

This commit is contained in:
Takeshi KOMIYA 2021-01-24 00:44:20 +09:00
parent f707cb30a1
commit f873a5890f

View File

@ -499,6 +499,10 @@ class Sphinx:
documents.
* ``''`` 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
Changed *rebuild* from a simple boolean (equivalent to ``''`` or
``'env'``) to a string. However, booleans are still accepted and