diff options
author | jfbu <jfbu@free.fr> | 2017-03-01 22:26:49 +0100 |
---|---|---|
committer | jfbu <jfbu@free.fr> | 2017-03-01 22:26:49 +0100 |
commit | c28e1da7633d314b9be783f2d9e34feec61777d4 (patch) | |
tree | 42101eb3336e5b7311d6bdc4ede4f317631e13c0 | |
parent | 74b46505f67fbf4ced1cf031bab9349ba37324c7 (diff) | |
download | sphinx-git-c28e1da7633d314b9be783f2d9e34feec61777d4.tar.gz |
Update (again) latex docs after PR##3429
-rw-r--r-- | doc/latex.rst | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/doc/latex.rst b/doc/latex.rst index 09121d331..e2c518058 100644 --- a/doc/latex.rst +++ b/doc/latex.rst @@ -414,16 +414,20 @@ Let us now list some macros from the package file - text styling commands (they have one argument): ``\sphinx<foo>`` with ``<foo>`` being one of ``strong``, ``bfcode``, ``email``, ``tablecontinued``, ``titleref``, ``menuselection``, ``accelerator``, ``crossref``, ``termref``, - ``optional``. By default and for backwards compatibility the ``\sphinx<foo>`` - expands to ``\<foo>`` hence the user can choose to customize rather the latter - (the non-prefixed macros will be left undefined if option - :confval:`latex_keep_old_macro_names` is set to ``False`` in :file:`conf.py`.) - - .. versionchanged:: 1.4.5 - use of ``\sphinx`` prefixed macro names to limit possibilities of conflict - with user added packages: if - :confval:`latex_keep_old_macro_names` is set to ``False`` in - :file:`conf.py` only the prefixed names are defined. + ``optional``. The non-prefixed macros will still be defined if option + :confval:`latex_keep_old_macro_names` has been set to ``True`` (default is + ``False``), in which case the prefixed macros expand to the + non-prefixed ones. + + .. versionadded:: 1.4.5 + Use of ``\sphinx`` prefixed macro names to limit possibilities of conflict + with LaTeX packages. + .. versionchanged:: 1.6 + The default value of :confval:`latex_keep_old_macro_names` changes to + ``False``, and even if set to ``True``, if a non-prefixed macro + already exists at ``sphinx.sty`` loading time, only the ``\sphinx`` + prefixed one will be defined. The setting will be removed at 1.7. + - more text styling commands: ``\sphinxstyle<bar>`` with ``<bar>`` one of ``indexentry``, ``indexextra``, ``indexpageref``, ``topictitle``, ``sidebartitle``, ``othertitle``, ``sidebarsubtitle``, ``thead``, |