mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
LaTeX: fix some documentation from #11224
This commit is contained in:
parent
75da848573
commit
d50ae3c1c9
@ -1454,10 +1454,11 @@ The ``\sphinxbox`` command
|
|||||||
|
|
||||||
.. versionadded:: 6.2.0
|
.. versionadded:: 6.2.0
|
||||||
|
|
||||||
It can be used to "box" inline text elements with all the customizability which
|
The ``\sphinxbox[key=value,...]{inline text}`` command can be used to "box"
|
||||||
has been described in :ref:`additionalcss`. It is a LaTeX command with one
|
inline text elements with all the customizability which has been described in
|
||||||
optional argument, which is a comma-separated list of key=value pairs, as for
|
:ref:`additionalcss`. It is a LaTeX command with one optional argument, which
|
||||||
:ref:`latexsphinxsetup`. Here is the complete list of keys:
|
is a comma-separated list of key=value pairs, as for :ref:`latexsphinxsetup`.
|
||||||
|
Here is the complete list of keys:
|
||||||
|
|
||||||
- ``border-width``,
|
- ``border-width``,
|
||||||
- ``border-top-width``, ``border-right-width``, ``border-bottom-width``,
|
- ``border-top-width``, ``border-right-width``, ``border-bottom-width``,
|
||||||
@ -1474,12 +1475,20 @@ Refer to :ref:`additionalcss` for important syntax information. The default
|
|||||||
configuration uses no shadow, a border-width of ``\fboxrule``, a padding of
|
configuration uses no shadow, a border-width of ``\fboxrule``, a padding of
|
||||||
``\fboxsep``, rounded corners (with radius ``\fboxsep``) and background and
|
``\fboxsep``, rounded corners (with radius ``\fboxsep``) and background and
|
||||||
border colors as for the default rendering of code-blocks. One can modify
|
border colors as for the default rendering of code-blocks. One can modify
|
||||||
these defaults via using ``\sphinxboxsetup[key=value,...]`` or also via
|
these defaults via using ``\sphinxboxsetup{key=value,...}`` or also via
|
||||||
``\sphinxsetup`` but all key names must then be prefixed with ``box_``.
|
``\sphinxsetup`` but all key names must then be prefixed with ``box_``.
|
||||||
|
|
||||||
A utility ``\newsphinxbox`` if provided to create an alternative,
|
.. hint::
|
||||||
e.g. ``\foo`` to ``\sphinxbox`` with a different set of defaults, but which
|
|
||||||
otherwise behaves the same. Here is a random example of use:
|
The comma separated key-value list is to be used within curly braces with
|
||||||
|
``\sphinxsetup`` (keys must then be prefixed with ``box_``) or
|
||||||
|
``\sphinxboxsetup``. In contrast key-value options given to ``\sphinxbox``
|
||||||
|
must be within square brackets, are they are... options. See examples
|
||||||
|
below.
|
||||||
|
|
||||||
|
A utility ``\newsphinxbox`` is provided to create a new boxing macro, say
|
||||||
|
``\foo`` which will act exactly like ``\sphinxbox`` but with a possibly
|
||||||
|
different set of initial default option values. Here is some example:
|
||||||
|
|
||||||
.. code-block:: latex
|
.. code-block:: latex
|
||||||
|
|
||||||
@ -1502,7 +1511,13 @@ otherwise behaves the same. Here is a random example of use:
|
|||||||
}
|
}
|
||||||
|
|
||||||
In the above example, you can probably use ``\renewcommand`` syntax if you
|
In the above example, you can probably use ``\renewcommand`` syntax if you
|
||||||
prefer (with ``[1]`` in place of ``#1`` then).
|
prefer (with ``[1]`` in place of ``#1`` then). There is also
|
||||||
|
``\renewsphinxbox`` which one can imagine inserting in the midst of a document
|
||||||
|
via the :dudir:`raw` directive, so that from that point on, all the custom
|
||||||
|
text elements using ``\foo`` will start using re-defined box parameters,
|
||||||
|
without having to redefine for example ``\sphinxguilabel`` as it already uses
|
||||||
|
``\foo``.
|
||||||
|
|
||||||
|
|
||||||
Environments
|
Environments
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -15,7 +15,7 @@
|
|||||||
% was to check if user had reverted that default and in fact pict2e was not
|
% was to check if user had reverted that default and in fact pict2e was not
|
||||||
% neeeded. But with \sphinxbox, we can not know for sure even in that case
|
% neeeded. But with \sphinxbox, we can not know for sure even in that case
|
||||||
% that pict2e is not needed. And even back then it would have been possible
|
% that pict2e is not needed. And even back then it would have been possible
|
||||||
% to user to try to emploi \sphinxsetup via raw directive in document body
|
% to user to try to employ \sphinxsetup via raw directive in document body
|
||||||
% and require some rounded corners (which was thus impossible to satisfy).
|
% and require some rounded corners (which was thus impossible to satisfy).
|
||||||
% Time to be much simpler and attempt unconditionally to load pict2e
|
% Time to be much simpler and attempt unconditionally to load pict2e
|
||||||
% immediately. This will also have advantage that we can use
|
% immediately. This will also have advantage that we can use
|
||||||
|
Loading…
Reference in New Issue
Block a user