IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add notes about Unicode and escaping of backslashes.

Browse Source
This commit is contained in:
Georg Brandl 2008-06-17 07:46:33 +00:00
parent c8dad69045
commit 1f73e1bee9
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/config.rst
View File

@ -28,6 +28,11 @@ Important points to note:
* Remember that document names use ``/`` as the path separator and don't contain * Remember that document names use ``/`` as the path separator and don't contain
the file name extension. the file name extension.
* Since :file:`conf.py` is read as a Python file, the usual rules apply for
encodings and Unicode support: declare the encoding using an encoding cookie
(a comment like ``# -*- coding: utf-8 -*-``) and use Unicode string literals
when you include non-ASCII characters in configuration values.
* The contents of the config namespace are pickled (so that Sphinx can find out * The contents of the config namespace are pickled (so that Sphinx can find out
when configuration changes), so it may not contain unpickleable values -- when configuration changes), so it may not contain unpickleable values --
delete them from the namespace with ``del`` if appropriate. Modules are delete them from the namespace with ``del`` if appropriate. Modules are
@ -377,12 +382,15 @@ These options influence LaTeX output.
.. confval:: latex_appendices .. confval:: latex_appendices
Documents to append as an appendix to all manuals. A list of document names to append as an appendix to all manuals.
.. confval:: latex_preamble .. confval:: latex_preamble
Additional LaTeX markup for the preamble. Additional LaTeX markup for the preamble.
Keep in mind that backslashes must be doubled in Python string literals to
avoid interpretation as escape sequences.
.. confval:: latex_use_modindex .. confval:: latex_use_modindex
If true, add a module index to LaTeX documents. Default is ``True``. If true, add a module index to LaTeX documents. Default is ``True``.