From e20f28ce7029357af374afca31a0839d3d5f4be1 Mon Sep 17 00:00:00 2001 From: jfbu Date: Thu, 11 May 2017 10:24:10 +0200 Subject: [PATCH] Improve latex docs of ``latex_use_latex_multicolumn`` config setting --- doc/config.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 39feaae78..b74ec52df 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -1640,17 +1640,16 @@ These options influence LaTeX output. See further :doc:`latex`. .. confval:: latex_use_latex_multicolumn - If ``False`` (default), the LaTeX writer uses for merged cells in grid - tables Sphinx's own macros. They have the advantage to allow the same - contents as in non-merged cells (inclusive of literal blocks, lists, - blockquotes, ...). But they assume that the columns are separated by the - standard vertical rule. Further, in case the :rst:dir:`tabularcolumns` - directive was employed to inject more macros (using LaTeX's mark-up of the - type ``>{..}``, ``<{..}``, ``@{..}``) the multicolumn cannot ignore these - extra macros, contrarily to LaTeX's own ``\multicolumn``; but Sphinx's - version does arrange for ignoring ``\columncolor`` like the standard - ``\multicolumn`` does. Setting to ``True`` means to use LaTeX's standard - ``\multicolumn`` macro. + The default is ``False``: it means that Sphinx's own macros are used for + merged cells from grid tables. They allow general contents (literal blocks, + lists, blockquotes, ...) but may have problems if the + :rst:dir:`tabularcolumns` directive was used to inject LaTeX mark-up of the + type ``>{..}``, ``<{..}``, ``@{..}`` as column specification. + + Setting to ``True`` means to use LaTeX's standard ``\multicolumn``; this is + incompatible with literal blocks in the horizontally merged cell, and also + with multiple paragraph in such cell if the table is rendered using + ``tabulary``. .. versionadded:: 1.6