mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add notes about Unicode and escaping of backslashes.
This commit is contained in:
parent
c8dad69045
commit
1f73e1bee9
@ -28,6 +28,11 @@ Important points to note:
|
||||
* Remember that document names use ``/`` as the path separator and don't contain
|
||||
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
|
||||
when configuration changes), so it may not contain unpickleable values --
|
||||
delete them from the namespace with ``del`` if appropriate. Modules are
|
||||
@ -377,12 +382,15 @@ These options influence LaTeX output.
|
||||
|
||||
.. 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
|
||||
|
||||
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
|
||||
|
||||
If true, add a module index to LaTeX documents. Default is ``True``.
|
||||
|
Loading…
Reference in New Issue
Block a user