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

update docs about :confval:latex_keep_old_macro_names

Browse Source
This commit is contained in:
jfbu 2017-02-18 12:07:44 +01:00
parent 43fd43932d
commit 3a090886b0
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/config.rst
View File

@ -1605,22 +1605,23 @@ These options influence LaTeX output. See further :doc:`latex`.
.. confval:: latex_keep_old_macro_names
If ``True`` (default) the ``\strong``, ``\code``, ``\bfcode``, ``\email``,
If ``True`` the ``\strong``, ``\code``, ``\bfcode``, ``\email``,
``\tablecontinued``, ``\titleref``, ``\menuselection``, ``\accelerator``,
``\crossref``, ``\termref``, and ``\optional`` text styling macros are
pre-defined by Sphinx and may be user-customized by some
``\renewcommand``'s inserted either via ``'preamble'`` key or :dudir:`raw
<raw-data-pass-through>` directive. If ``False``, only ``\sphinxstrong``,
etc... macros are defined (and may be redefined by user). Setting to
``False`` may help solve macro name conflicts caused by user-added latex
packages.
etc... macros are defined (and may be redefined by user).
The default is ``False`` as it solves macro name conflicts caused by
user-added latex packages. For example ``fontspec v2.6`` defines its own
``\strong`` macro.
.. versionadded:: 1.4.5
.. versionchanged:: 1.6
For ``'xelatex'`` engine, the default is ``False`` because LaTeX package
``fontspec v2.6`` defines its own ``\strong`` macro.
Default was changed from ``True`` to ``False``.
.. deprecated:: 1.6
This setting will be removed at Sphinx 1.7.
.. confval:: latex_elements