Shorten a definition list in latex docs

This commit is contained in:
jfbu 2017-06-05 16:30:14 +02:00
parent bd8c7e1410
commit 8b35c36cfe

View File

@ -60,7 +60,7 @@ It is achieved via usage of the
.. highlight:: latex .. highlight:: latex
If the size of the ``'preamble'`` contents become inconvenient, one may put If the size of the ``'preamble'`` contents becomes inconvenient, one may move
all needed macros into some file :file:`mystyle.tex` of the project source all needed macros into some file :file:`mystyle.tex` of the project source
repertory, and get LaTeX to import it at run time:: repertory, and get LaTeX to import it at run time::
@ -224,9 +224,12 @@ The available styling options
``TitleColor`` ``TitleColor``
default ``{rgb}{0.126,0.263,0.361}``. The colour for titles (as configured default ``{rgb}{0.126,0.263,0.361}``. The colour for titles (as configured
via use of package "titlesec".) It must obey the syntax of the via use of package "titlesec".)
``\definecolor`` command. Check the documentation of packages ``color`` or
``xcolor``. .. warning::
Colours set via ``'sphinxsetup'`` must obey the syntax of the
argument of the ``color/xcolor`` packages ``\definecolor`` command.
``InnerLinkColor`` ``InnerLinkColor``
default ``{rgb}{0.208,0.374,0.486}``. A colour passed to ``hyperref`` as default ``{rgb}{0.208,0.374,0.486}``. A colour passed to ``hyperref`` as
@ -260,85 +263,35 @@ The available styling options
``shadowrule`` ``shadowrule``
default ``\fboxrule``. The width of the frame around :dudir:`topic` boxes. default ``\fboxrule``. The width of the frame around :dudir:`topic` boxes.
``noteBorderColor`` |notebdcolors|
default ``{rgb}{0,0,0}``. The colour for the two horizontal rules used by default ``{rgb}{0,0,0}`` (black). The colour for the two horizontal rules
Sphinx in LaTeX for styling a used by Sphinx in LaTeX for styling a :dudir:`note` type admonition.
:dudir:`note` admonition. Defaults to black.
.. note:: .. note::
The actual name of the colour as declared to "color" or "xcolor" is The actual colour names declared to "color" or "xcolor" are prefixed with
``sphinxnoteBorderColor``. The same "sphinx" prefix applies to all "sphinx".
colours for notices and admonitions.
``hintBorderColor`` ``noteborder``, ``hintborder``, ``importantborder``, ``tipborder``
default ``{rgb}{0,0,0}``. id.
``importantBorderColor``
default ``{rgb}{0,0,0}``. id.
``tipBorderColor``
default ``{rgb}{0,0,0}``. id.
``noteborder``
default ``0.5pt``. The width of the two horizontal rules. default ``0.5pt``. The width of the two horizontal rules.
``hintborder`` .. only:: not latex
default ``0.5pt``. id.
``importantborder`` |warningbdcolors|
default ``0.5pt``. id. default ``{rgb}{0,0,0}`` (black). The colour for the admonition frame.
``tipborder`` .. only:: latex
default ``0.5pt``. id.
``warningBorderColor`` |wgbdcolorslatex|
default ``{rgb}{0,0,0}``. The colour of the frame for :dudir:`warning` type default ``{rgb}{0,0,0}`` (black). The colour for the admonition frame.
admonitions. Defaults to black.
``cautionBorderColor`` |warningbgcolors|
default ``{rgb}{0,0,0}``. id. default ``{rgb}{1,1,1}`` (white). The background colours for the respective
admonitions.
``attentionBorderColor`` |warningborders|
default ``{rgb}{0,0,0}``. id.
``dangerBorderColor``
default ``{rgb}{0,0,0}``. id.
``errorBorderColor``
default ``{rgb}{0,0,0}``. id.
``warningBgColor``
default ``{rgb}{1,1,1}``. The background colour for :dudir:`warning` type
admonition, defaults to white.
``cautionBgColor``
default ``{rgb}{1,1,1}``. id.
``attentionBgColor``
default ``{rgb}{1,1,1}``. id.
``dangerBgColor``
default ``{rgb}{1,1,1}``. id.
``errorBgColor``
default ``{rgb}{1,1,1}``. id.
``warningborder``
default ``1pt``. The width of the frame. default ``1pt``. The width of the frame.
``cautionborder``
default ``1pt``. id.
``attentionborder``
default ``1pt``. id.
``dangerborder``
default ``1pt``. id.
``errorborder``
default ``1pt``. id.
``AtStartFootnote`` ``AtStartFootnote``
default ``\mbox{ }``. LaTeX macros inserted at the start of the footnote default ``\mbox{ }``. LaTeX macros inserted at the start of the footnote
text at bottom of page, after the footnote number. text at bottom of page, after the footnote number.
@ -353,6 +306,28 @@ The available styling options
``HeaderFamily`` ``HeaderFamily``
default ``\sffamily\bfseries``. Sets the font used by headings. default ``\sffamily\bfseries``. Sets the font used by headings.
.. |notebdcolors| replace:: ``noteBorderColor``, ``hintBorderColor``,
``importantBorderColor``, ``tipBorderColor``
.. |warningbdcolors| replace:: ``warningBorderColor``, ``cautionBorderColor``,
``attentionBorderColor``, ``dangerBorderColor``,
``errorBorderColor``
.. |wgbdcolorslatex| replace:: ``warningBorderColor``, ``cautionBorderColor``,
``attentionB..C..``, ``dangerB..C..``,
``errorB..C..``
.. else latex goes into right margin, as it does not hyphenate the names
.. |warningbgcolors| replace:: ``warningBgColor``, ``cautionBgColor``,
``attentionBgColor``, ``dangerBgColor``,
``errorBgColor``
.. |warningborders| replace:: ``warningBorder``, ``cautionBorder``,
``attentionBorder``, ``dangerBorder``,
``errorBorder``
LaTeX macros and environments LaTeX macros and environments
----------------------------- -----------------------------