diff options
| author | jfbu <jfbu@free.fr> | 2017-10-19 10:23:41 +0300 |
|---|---|---|
| committer | jfbu <jfbu@free.fr> | 2017-10-19 10:23:41 +0300 |
| commit | 77c5aaaa973dfaab652197ae345f17f904a943fe (patch) | |
| tree | 900e5a01dd7a488913f4292b060f546ced4f8ab3 /doc | |
| parent | 77e673d08c7bab36cdd42972c2c67f65d36331b6 (diff) | |
Fix #4134: [doc] docutils.conf is not documented explicitly
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/config.rst b/doc/config.rst index a094195e9..160cc3c5c 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -9,8 +9,20 @@ The build configuration file :synopsis: Build configuration file. The :term:`configuration directory` must contain a file named :file:`conf.py`. -This file (containing Python code) is called the "build configuration file" and -contains all configuration needed to customize Sphinx input and output behavior. +This file (containing Python code) is called the "build configuration file" +and contains (almost) all configuration needed to customize Sphinx input +and output behavior. + + An optional file `docutils.conf`_ can be added to the configuration + directory to adjust `Docutils`_ configuration if not otherwise overriden or + set by Sphinx; this applies in particular to the `Docutils smart_quotes + setting`_. + + .. _`docutils`: http://docutils.sourceforge.net/ + + .. _`docutils.conf`: http://docutils.sourceforge.net/docs/user/config.html + + .. _`Docutils smart_quotes setting`: http://docutils.sourceforge.net/docs/user/config.html#smart-quotes The configuration file is executed as Python code at build time (using :func:`execfile`, and with the current directory set to its containing |