From 3a090886b025c962da68a573c618cad847de0ed3 Mon Sep 17 00:00:00 2001 From: jfbu Date: Sat, 18 Feb 2017 12:07:44 +0100 Subject: [PATCH] update docs about :confval:`latex_keep_old_macro_names` --- doc/config.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 79c08081a..146f98d8b 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -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 ` 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