mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
docs: Fix typo, replace field lists with paragraphs
Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
parent
52bb0b02bb
commit
f3360e6922
108
doc/latex.rst
108
doc/latex.rst
@ -70,13 +70,13 @@ Keys that you may want to override include:
|
|||||||
Paper size option of the document class (``'a4paper'`` or
|
Paper size option of the document class (``'a4paper'`` or
|
||||||
``'letterpaper'``)
|
``'letterpaper'``)
|
||||||
|
|
||||||
:Default: ``'letterpaper'``
|
Default: ``'letterpaper'``
|
||||||
|
|
||||||
``'pointsize'``
|
``'pointsize'``
|
||||||
Point size option of the document class (``'10pt'``, ``'11pt'`` or
|
Point size option of the document class (``'10pt'``, ``'11pt'`` or
|
||||||
``'12pt'``)
|
``'12pt'``)
|
||||||
|
|
||||||
:Default: ``'10pt'``
|
Default: ``'10pt'``
|
||||||
|
|
||||||
``'pxunit'``
|
``'pxunit'``
|
||||||
The value of the ``px`` when used in image attributes ``width`` and
|
The value of the ``px`` when used in image attributes ``width`` and
|
||||||
@ -87,7 +87,7 @@ Keys that you may want to override include:
|
|||||||
used in the specification); for ``72px=1in``, simply use ``'1bp'``; for
|
used in the specification); for ``72px=1in``, simply use ``'1bp'``; for
|
||||||
``90px=1in``, use ``'0.8bp'`` or ``'0.803pt'``.
|
``90px=1in``, use ``'0.8bp'`` or ``'0.803pt'``.
|
||||||
|
|
||||||
:Default: ``'0.75bp'``
|
Default: ``'0.75bp'``
|
||||||
|
|
||||||
.. versionadded:: 1.5
|
.. versionadded:: 1.5
|
||||||
|
|
||||||
@ -95,7 +95,7 @@ Keys that you may want to override include:
|
|||||||
A string which will be positioned early in the preamble, designed to
|
A string which will be positioned early in the preamble, designed to
|
||||||
contain ``\\PassOptionsToPackage{options}{foo}`` commands.
|
contain ``\\PassOptionsToPackage{options}{foo}`` commands.
|
||||||
|
|
||||||
:Default: ``''``
|
Default: ``''``
|
||||||
|
|
||||||
.. versionadded:: 1.4
|
.. versionadded:: 1.4
|
||||||
|
|
||||||
@ -119,7 +119,7 @@ Keys that you may want to override include:
|
|||||||
build repertory before next PDF build, else left-over auxiliary
|
build repertory before next PDF build, else left-over auxiliary
|
||||||
files are likely to break the build.
|
files are likely to break the build.
|
||||||
|
|
||||||
:Default: ``'\\usepackage{babel}'`` (``''`` for Japenese documents)
|
Default: ``'\\usepackage{babel}'`` (``''`` for Japanese documents)
|
||||||
|
|
||||||
.. versionchanged:: 1.5
|
.. versionchanged:: 1.5
|
||||||
For :confval:`latex_engine` set to ``'xelatex'``, the default
|
For :confval:`latex_engine` set to ``'xelatex'``, the default
|
||||||
@ -176,7 +176,7 @@ Keys that you may want to override include:
|
|||||||
``'platex'`` (Japanese documents) engine supports individual Cyrillic and
|
``'platex'`` (Japanese documents) engine supports individual Cyrillic and
|
||||||
Greek letters with no need of extra user set-up.
|
Greek letters with no need of extra user set-up.
|
||||||
|
|
||||||
:Default: ``'\\usepackage{times}'`` (or ``''`` when using a Cyrillic script)
|
Default: ``'\\usepackage{times}'`` (or ``''`` when using a Cyrillic script)
|
||||||
|
|
||||||
.. versionchanged:: 1.2
|
.. versionchanged:: 1.2
|
||||||
Defaults to ``''`` when the :confval:`language` uses the Cyrillic
|
Defaults to ``''`` when the :confval:`language` uses the Cyrillic
|
||||||
@ -194,7 +194,7 @@ Keys that you may want to override include:
|
|||||||
"fncychap" styles you can try are "Lenny", "Glenn", "Conny", "Rejne" and
|
"fncychap" styles you can try are "Lenny", "Glenn", "Conny", "Rejne" and
|
||||||
"Bjornstrup". You can also set this to ``''`` to disable fncychap.
|
"Bjornstrup". You can also set this to ``''`` to disable fncychap.
|
||||||
|
|
||||||
:Default: ``'\\usepackage[Bjarne]{fncychap}'`` for English documents,
|
Default: ``'\\usepackage[Bjarne]{fncychap}'`` for English documents,
|
||||||
``'\\usepackage[Sonny]{fncychap}'`` for internationalized documents, and
|
``'\\usepackage[Sonny]{fncychap}'`` for internationalized documents, and
|
||||||
``''`` for Japanese documents.
|
``''`` for Japanese documents.
|
||||||
|
|
||||||
@ -214,7 +214,7 @@ Keys that you may want to override include:
|
|||||||
|
|
||||||
latex_additional_files = ["mystyle.sty"]
|
latex_additional_files = ["mystyle.sty"]
|
||||||
|
|
||||||
:Default: ``''``
|
Default: ``''``
|
||||||
|
|
||||||
``'figure_align'``
|
``'figure_align'``
|
||||||
Latex figure float alignment. Whenever an image doesn't fit into the current
|
Latex figure float alignment. Whenever an image doesn't fit into the current
|
||||||
@ -223,14 +223,14 @@ Keys that you may want to override include:
|
|||||||
floating and position figures strictly in the order they appear in the
|
floating and position figures strictly in the order they appear in the
|
||||||
source.
|
source.
|
||||||
|
|
||||||
:Default: ``'htbp'`` (here, top, bottom, page)
|
Default: ``'htbp'`` (here, top, bottom, page)
|
||||||
|
|
||||||
.. versionadded:: 1.3
|
.. versionadded:: 1.3
|
||||||
|
|
||||||
``'atendofbody'``
|
``'atendofbody'``
|
||||||
Additional document content (right before the indices).
|
Additional document content (right before the indices).
|
||||||
|
|
||||||
:Default: ``''``
|
Default: ``''``
|
||||||
|
|
||||||
.. versionadded:: 1.5
|
.. versionadded:: 1.5
|
||||||
|
|
||||||
@ -250,14 +250,14 @@ Keys that you may want to override include:
|
|||||||
If you'd like to load additional LaTeX packages after hyperref, use
|
If you'd like to load additional LaTeX packages after hyperref, use
|
||||||
``'preamble'`` key instead.
|
``'preamble'`` key instead.
|
||||||
|
|
||||||
:Default: ``''``
|
Default: ``''``
|
||||||
|
|
||||||
.. versionadded:: 2.3
|
.. versionadded:: 2.3
|
||||||
|
|
||||||
``'footer'``
|
``'footer'``
|
||||||
Additional footer content (before the indices).
|
Additional footer content (before the indices).
|
||||||
|
|
||||||
:Default: ``''``
|
Default: ``''``
|
||||||
|
|
||||||
.. deprecated:: 1.5
|
.. deprecated:: 1.5
|
||||||
Use ``'atendofbody'`` key instead.
|
Use ``'atendofbody'`` key instead.
|
||||||
@ -269,7 +269,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
'openany'`` will allow chapters (for documents of the ``'manual'``
|
'openany'`` will allow chapters (for documents of the ``'manual'``
|
||||||
type) to start on any page.
|
type) to start on any page.
|
||||||
|
|
||||||
:Default: ``''``
|
Default: ``''``
|
||||||
|
|
||||||
.. versionadded:: 1.2
|
.. versionadded:: 1.2
|
||||||
|
|
||||||
@ -292,14 +292,14 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
is executed inside the document preamble. Use then rather the
|
is executed inside the document preamble. Use then rather the
|
||||||
dedicated commands of this LaTeX package.
|
dedicated commands of this LaTeX package.
|
||||||
|
|
||||||
:Default: ``6``
|
Default: ``6``
|
||||||
|
|
||||||
.. versionadded:: 1.5
|
.. versionadded:: 1.5
|
||||||
|
|
||||||
``'inputenc'``
|
``'inputenc'``
|
||||||
"inputenc" package inclusion.
|
"inputenc" package inclusion.
|
||||||
|
|
||||||
:Default: ``'\\usepackage[utf8]{inputenc}'`` when using pdflatex, else
|
Default: ``'\\usepackage[utf8]{inputenc}'`` when using pdflatex, else
|
||||||
``''``
|
``''``
|
||||||
|
|
||||||
.. versionchanged:: 1.4.3
|
.. versionchanged:: 1.4.3
|
||||||
@ -309,7 +309,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
``'cmappkg'``
|
``'cmappkg'``
|
||||||
"cmap" package inclusion.
|
"cmap" package inclusion.
|
||||||
|
|
||||||
:Default: ``'\\usepackage{cmap}'``
|
Default: ``'\\usepackage{cmap}'``
|
||||||
|
|
||||||
.. versionadded:: 1.2
|
.. versionadded:: 1.2
|
||||||
|
|
||||||
@ -344,7 +344,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
loading ``fontenc``. Thus, use this key with this extra at its
|
loading ``fontenc``. Thus, use this key with this extra at its
|
||||||
start if needed.
|
start if needed.
|
||||||
|
|
||||||
:Default: ``'\\usepackage[T1]{fontenc}'``
|
Default: ``'\\usepackage[T1]{fontenc}'``
|
||||||
|
|
||||||
.. versionchanged:: 1.5
|
.. versionchanged:: 1.5
|
||||||
Defaults to ``'\\usepackage{fontspec}'`` when
|
Defaults to ``'\\usepackage{fontspec}'`` when
|
||||||
@ -388,7 +388,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
With ``'platex'`` (Japanese), ``'xelatex'`` or ``'lualatex'``, this
|
With ``'platex'`` (Japanese), ``'xelatex'`` or ``'lualatex'``, this
|
||||||
key is ignored.
|
key is ignored.
|
||||||
|
|
||||||
:Default: ``'\\usepackage{textalpha}'`` or ``''`` if ``fontenc`` does not
|
Default: ``'\\usepackage{textalpha}'`` or ``''`` if ``fontenc`` does not
|
||||||
include the ``LGR`` option.
|
include the ``LGR`` option.
|
||||||
|
|
||||||
.. versionadded:: 2.0
|
.. versionadded:: 2.0
|
||||||
@ -406,7 +406,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
which can be customized via corresponding :ref:`'sphinxsetup' options
|
which can be customized via corresponding :ref:`'sphinxsetup' options
|
||||||
<latexsphinxsetup>`.
|
<latexsphinxsetup>`.
|
||||||
|
|
||||||
:Default: ``'\\usepackage{geometry}'`` (or
|
Default: ``'\\usepackage{geometry}'`` (or
|
||||||
``'\\usepackage[dvipdfm]{geometry}'`` for Japanese documents)
|
``'\\usepackage[dvipdfm]{geometry}'`` for Japanese documents)
|
||||||
|
|
||||||
.. versionadded:: 1.5
|
.. versionadded:: 1.5
|
||||||
@ -450,7 +450,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
material>}\sphinxmaketitle'``, then ``<Extra material>`` will be
|
material>}\sphinxmaketitle'``, then ``<Extra material>`` will be
|
||||||
typeset on back of title page (``'manual'`` docclass only).
|
typeset on back of title page (``'manual'`` docclass only).
|
||||||
|
|
||||||
:Default: ``'\\sphinxmaketitle'``
|
Default: ``'\\sphinxmaketitle'``
|
||||||
|
|
||||||
.. versionchanged:: 1.8.3
|
.. versionchanged:: 1.8.3
|
||||||
Original ``\maketitle`` from document class is not overwritten,
|
Original ``\maketitle`` from document class is not overwritten,
|
||||||
@ -465,7 +465,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
*author* used in the tuples of :confval:`latex_documents`, it is inserted as
|
*author* used in the tuples of :confval:`latex_documents`, it is inserted as
|
||||||
LaTeX markup.
|
LaTeX markup.
|
||||||
|
|
||||||
:Default: ``'Release'``
|
Default: ``'Release'``
|
||||||
|
|
||||||
``'tableofcontents'``
|
``'tableofcontents'``
|
||||||
"tableofcontents" call. The default of ``'\\sphinxtableofcontents'`` is a
|
"tableofcontents" call. The default of ``'\\sphinxtableofcontents'`` is a
|
||||||
@ -473,7 +473,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
by user loaded packages. Override if you want to generate a different table
|
by user loaded packages. Override if you want to generate a different table
|
||||||
of contents or put content between the title page and the TOC.
|
of contents or put content between the title page and the TOC.
|
||||||
|
|
||||||
:Default: ``'\\sphinxtableofcontents'``
|
Default: ``'\\sphinxtableofcontents'``
|
||||||
|
|
||||||
.. versionchanged:: 1.5
|
.. versionchanged:: 1.5
|
||||||
Previously the meaning of ``\tableofcontents`` itself was modified
|
Previously the meaning of ``\tableofcontents`` itself was modified
|
||||||
@ -484,7 +484,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
Commands used to display transitions. Override if you want to display
|
Commands used to display transitions. Override if you want to display
|
||||||
transitions differently.
|
transitions differently.
|
||||||
|
|
||||||
:Default: ``'\n\n\\bigskip\\hrule\\bigskip\n\n'``
|
Default: ``'\n\n\\bigskip\\hrule\\bigskip\n\n'``
|
||||||
|
|
||||||
.. versionadded:: 1.2
|
.. versionadded:: 1.2
|
||||||
|
|
||||||
@ -497,7 +497,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
example ``'\\footnotesize\\raggedright\\printindex'`` is advisable when the
|
example ``'\\footnotesize\\raggedright\\printindex'`` is advisable when the
|
||||||
index is full of long entries.
|
index is full of long entries.
|
||||||
|
|
||||||
:Default: ``'\\printindex'``
|
Default: ``'\\printindex'``
|
||||||
|
|
||||||
``'fvset'``
|
``'fvset'``
|
||||||
Customization of ``fancyvrb`` LaTeX package. The default value of
|
Customization of ``fancyvrb`` LaTeX package. The default value of
|
||||||
@ -505,7 +505,7 @@ Keys that don't need to be overridden unless in special cases are:
|
|||||||
width of the monospace font, used in code-blocks. You may need to modify
|
width of the monospace font, used in code-blocks. You may need to modify
|
||||||
this if you use custom fonts.
|
this if you use custom fonts.
|
||||||
|
|
||||||
:Default: ``'\\fvset{fontsize=\\small}'``
|
Default: ``'\\fvset{fontsize=\\small}'``
|
||||||
|
|
||||||
.. versionadded:: 1.8
|
.. versionadded:: 1.8
|
||||||
|
|
||||||
@ -598,7 +598,7 @@ macros may be significant.
|
|||||||
the text height set to an integer multiple of the baselineskip, with the
|
the text height set to an integer multiple of the baselineskip, with the
|
||||||
closest fit for the margins.
|
closest fit for the margins.
|
||||||
|
|
||||||
:Default: ``1in`` (equivalent to ``{1in,1in}``)
|
Default: ``1in`` (equivalent to ``{1in,1in}``)
|
||||||
|
|
||||||
.. hint::
|
.. hint::
|
||||||
|
|
||||||
@ -615,7 +615,7 @@ macros may be significant.
|
|||||||
The ``\marginparwidth`` LaTeX dimension. For Japanese documents, the value
|
The ``\marginparwidth`` LaTeX dimension. For Japanese documents, the value
|
||||||
is modified to be the closest integer multiple of the *zenkaku* width.
|
is modified to be the closest integer multiple of the *zenkaku* width.
|
||||||
|
|
||||||
:Default: ``0.5in``
|
Default: ``0.5in``
|
||||||
|
|
||||||
.. versionadded:: 1.5.3
|
.. versionadded:: 1.5.3
|
||||||
|
|
||||||
@ -624,18 +624,18 @@ macros may be significant.
|
|||||||
framed. Setting it to ``false`` does not deactivate use of package
|
framed. Setting it to ``false`` does not deactivate use of package
|
||||||
"framed", because it is still in use for the optional background colour.
|
"framed", because it is still in use for the optional background colour.
|
||||||
|
|
||||||
:Default: ``true``.
|
Default: ``true``.
|
||||||
|
|
||||||
``verbatimwrapslines``
|
``verbatimwrapslines``
|
||||||
Boolean to specify if long lines in :rst:dir:`code-block`\ 's contents are
|
Boolean to specify if long lines in :rst:dir:`code-block`\ 's contents are
|
||||||
wrapped.
|
wrapped.
|
||||||
|
|
||||||
:Default: ``true``
|
Default: ``true``
|
||||||
|
|
||||||
``literalblockcappos``
|
``literalblockcappos``
|
||||||
Decides the caption position: either ``b`` ("bottom") or ``t`` ("top").
|
Decides the caption position: either ``b`` ("bottom") or ``t`` ("top").
|
||||||
|
|
||||||
:Default: ``t``
|
Default: ``t``
|
||||||
|
|
||||||
.. versionadded:: 1.7
|
.. versionadded:: 1.7
|
||||||
|
|
||||||
@ -643,7 +643,7 @@ macros may be significant.
|
|||||||
Boolean to specify if code-blocks display "continued on next page" and
|
Boolean to specify if code-blocks display "continued on next page" and
|
||||||
"continued from previous page" hints in case of pagebreaks.
|
"continued from previous page" hints in case of pagebreaks.
|
||||||
|
|
||||||
:Default: ``true``
|
Default: ``true``
|
||||||
|
|
||||||
.. versionadded:: 1.6.3
|
.. versionadded:: 1.6.3
|
||||||
.. versionchanged:: 1.7
|
.. versionchanged:: 1.7
|
||||||
@ -653,7 +653,7 @@ macros may be significant.
|
|||||||
Horizontal position relative to the framed contents: either ``l`` (left
|
Horizontal position relative to the framed contents: either ``l`` (left
|
||||||
aligned), ``r`` (right aligned) or ``c`` (centered).
|
aligned), ``r`` (right aligned) or ``c`` (centered).
|
||||||
|
|
||||||
:Default: ``r``
|
Default: ``r``
|
||||||
|
|
||||||
.. versionadded:: 1.7
|
.. versionadded:: 1.7
|
||||||
|
|
||||||
@ -661,7 +661,7 @@ macros may be significant.
|
|||||||
Boolean to specify if long lines in :dudir:`parsed-literal`\ 's contents
|
Boolean to specify if long lines in :dudir:`parsed-literal`\ 's contents
|
||||||
should wrap.
|
should wrap.
|
||||||
|
|
||||||
:Default: ``true``
|
Default: ``true``
|
||||||
|
|
||||||
.. versionadded:: 1.5.2
|
.. versionadded:: 1.5.2
|
||||||
set this option value to ``false`` to recover former behaviour.
|
set this option value to ``false`` to recover former behaviour.
|
||||||
@ -673,7 +673,7 @@ macros may be significant.
|
|||||||
``. , ; ? ! /`` and ``\``. Due to TeX internals, white space in the line
|
``. , ; ? ! /`` and ``\``. Due to TeX internals, white space in the line
|
||||||
will be stretched (or shrunk) in order to accommodate the linebreak.
|
will be stretched (or shrunk) in order to accommodate the linebreak.
|
||||||
|
|
||||||
:Default: ``true``
|
Default: ``true``
|
||||||
|
|
||||||
.. versionadded:: 1.5
|
.. versionadded:: 1.5
|
||||||
set this option value to ``false`` to recover former behaviour.
|
set this option value to ``false`` to recover former behaviour.
|
||||||
@ -685,7 +685,7 @@ macros may be significant.
|
|||||||
When a long code line is split, the last space character from the source
|
When a long code line is split, the last space character from the source
|
||||||
code line right before the linebreak location is typeset using this.
|
code line right before the linebreak location is typeset using this.
|
||||||
|
|
||||||
:Default: ``\textcolor{red}{\textvisiblespace}``
|
Default: ``\textcolor{red}{\textvisiblespace}``
|
||||||
|
|
||||||
``verbatimcontinued``
|
``verbatimcontinued``
|
||||||
A LaTeX macro inserted at start of continuation code lines. Its
|
A LaTeX macro inserted at start of continuation code lines. Its
|
||||||
@ -701,7 +701,7 @@ macros may be significant.
|
|||||||
``TitleColor``
|
``TitleColor``
|
||||||
The colour for titles (as configured via use of package "titlesec".)
|
The colour for titles (as configured via use of package "titlesec".)
|
||||||
|
|
||||||
:Default: ``{rgb}{0.126,0.263,0.361}``
|
Default: ``{rgb}{0.126,0.263,0.361}``
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
@ -712,28 +712,28 @@ macros may be significant.
|
|||||||
A colour passed to ``hyperref`` as value of ``linkcolor`` and
|
A colour passed to ``hyperref`` as value of ``linkcolor`` and
|
||||||
``citecolor``.
|
``citecolor``.
|
||||||
|
|
||||||
:Default: ``{rgb}{0.208,0.374,0.486}``.
|
Default: ``{rgb}{0.208,0.374,0.486}``.
|
||||||
|
|
||||||
``OuterLinkColor``
|
``OuterLinkColor``
|
||||||
A colour passed to ``hyperref`` as value of ``filecolor``, ``menucolor``,
|
A colour passed to ``hyperref`` as value of ``filecolor``, ``menucolor``,
|
||||||
and ``urlcolor``.
|
and ``urlcolor``.
|
||||||
|
|
||||||
:Default: ``{rgb}{0.216,0.439,0.388}``
|
Default: ``{rgb}{0.216,0.439,0.388}``
|
||||||
|
|
||||||
``VerbatimColor``
|
``VerbatimColor``
|
||||||
The background colour for :rst:dir:`code-block`\ s.
|
The background colour for :rst:dir:`code-block`\ s.
|
||||||
|
|
||||||
:Default: ``{rgb}{1,1,1}`` (white)
|
Default: ``{rgb}{1,1,1}`` (white)
|
||||||
|
|
||||||
``VerbatimBorderColor``
|
``VerbatimBorderColor``
|
||||||
The frame color.
|
The frame color.
|
||||||
|
|
||||||
:Default: ``{rgb}{0,0,0}`` (black)
|
Default: ``{rgb}{0,0,0}`` (black)
|
||||||
|
|
||||||
``VerbatimHighlightColor``
|
``VerbatimHighlightColor``
|
||||||
The color for highlighted lines.
|
The color for highlighted lines.
|
||||||
|
|
||||||
:Default: ``{rgb}{0.878,1,1}``
|
Default: ``{rgb}{0.878,1,1}``
|
||||||
|
|
||||||
.. versionadded:: 1.6.6
|
.. versionadded:: 1.6.6
|
||||||
|
|
||||||
@ -745,75 +745,75 @@ macros may be significant.
|
|||||||
``verbatimsep``
|
``verbatimsep``
|
||||||
The separation between code lines and the frame.
|
The separation between code lines and the frame.
|
||||||
|
|
||||||
:Default: ``\fboxsep``
|
Default: ``\fboxsep``
|
||||||
|
|
||||||
``verbatimborder``
|
``verbatimborder``
|
||||||
The width of the frame around :rst:dir:`code-block`\ s.
|
The width of the frame around :rst:dir:`code-block`\ s.
|
||||||
|
|
||||||
:Default: ``\fboxrule``
|
Default: ``\fboxrule``
|
||||||
|
|
||||||
``shadowsep``
|
``shadowsep``
|
||||||
The separation between contents and frame for :dudir:`contents` and
|
The separation between contents and frame for :dudir:`contents` and
|
||||||
:dudir:`topic` boxes.
|
:dudir:`topic` boxes.
|
||||||
|
|
||||||
:Default: ``5pt``
|
Default: ``5pt``
|
||||||
|
|
||||||
``shadowsize``
|
``shadowsize``
|
||||||
The width of the lateral "shadow" to the right.
|
The width of the lateral "shadow" to the right.
|
||||||
|
|
||||||
:Default: ``4pt``
|
Default: ``4pt``
|
||||||
|
|
||||||
``shadowrule``
|
``shadowrule``
|
||||||
The width of the frame around :dudir:`topic` boxes.
|
The width of the frame around :dudir:`topic` boxes.
|
||||||
|
|
||||||
:Default: ``\fboxrule``
|
Default: ``\fboxrule``
|
||||||
|
|
||||||
|notebdcolors|
|
|notebdcolors|
|
||||||
The colour for the two horizontal rules used by Sphinx in LaTeX for styling
|
The colour for the two horizontal rules used by Sphinx in LaTeX for styling
|
||||||
a :dudir:`note` type admonition.
|
a :dudir:`note` type admonition.
|
||||||
|
|
||||||
:Default: ``{rgb}{0,0,0}`` (black)
|
Default: ``{rgb}{0,0,0}`` (black)
|
||||||
|
|
||||||
``noteborder``, ``hintborder``, ``importantborder``, ``tipborder``
|
``noteborder``, ``hintborder``, ``importantborder``, ``tipborder``
|
||||||
The width of the two horizontal rules.
|
The width of the two horizontal rules.
|
||||||
|
|
||||||
:Default: ``0.5pt``
|
Default: ``0.5pt``
|
||||||
|
|
||||||
.. only:: not latex
|
.. only:: not latex
|
||||||
|
|
||||||
|warningbdcolors|
|
|warningbdcolors|
|
||||||
The colour for the admonition frame.
|
The colour for the admonition frame.
|
||||||
|
|
||||||
:Default: ``{rgb}{0,0,0}`` (black)
|
Default: ``{rgb}{0,0,0}`` (black)
|
||||||
|
|
||||||
.. only:: latex
|
.. only:: latex
|
||||||
|
|
||||||
|wgbdcolorslatex|
|
|wgbdcolorslatex|
|
||||||
The colour for the admonition frame.
|
The colour for the admonition frame.
|
||||||
|
|
||||||
:Default: ``{rgb}{0,0,0}`` (black)
|
Default: ``{rgb}{0,0,0}`` (black)
|
||||||
|
|
||||||
|warningbgcolors|
|
|warningbgcolors|
|
||||||
The background colours for the respective admonitions.
|
The background colours for the respective admonitions.
|
||||||
|
|
||||||
:Default: ``{rgb}{1,1,1}`` (white)
|
Default: ``{rgb}{1,1,1}`` (white)
|
||||||
|
|
||||||
|warningborders|
|
|warningborders|
|
||||||
The width of the frame.
|
The width of the frame.
|
||||||
|
|
||||||
:Default: ``1pt``
|
Default: ``1pt``
|
||||||
|
|
||||||
``AtStartFootnote``
|
``AtStartFootnote``
|
||||||
LaTeX macros inserted at the start of the footnote text at bottom of page,
|
LaTeX macros inserted at the start of the footnote text at bottom of page,
|
||||||
after the footnote number.
|
after the footnote number.
|
||||||
|
|
||||||
:Default: ``\mbox{ }``
|
Default: ``\mbox{ }``
|
||||||
|
|
||||||
``BeforeFootnote``
|
``BeforeFootnote``
|
||||||
LaTeX macros inserted before the footnote mark. The default removes
|
LaTeX macros inserted before the footnote mark. The default removes
|
||||||
possible space before it (else, TeX could insert a line break there).
|
possible space before it (else, TeX could insert a line break there).
|
||||||
|
|
||||||
:Default: ``\leavevmode\unskip``
|
Default: ``\leavevmode\unskip``
|
||||||
|
|
||||||
.. versionadded:: 1.5
|
.. versionadded:: 1.5
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user