summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-François B <2589111+jfbu@users.noreply.github.com>2023-03-07 19:10:43 +0100
committerJean-François B <2589111+jfbu@users.noreply.github.com>2023-03-07 19:10:43 +0100
commitd50ae3c1c917cfa075125ab44c0c8f0eb7aad3ed (patch)
treeb9d14eda3c2240f3c1084c326f89b3a0d88eae7d
parent75da848573f8c057affb72a0c7b443f027bace64 (diff)
downloadsphinx-git-d50ae3c1c917cfa075125ab44c0c8f0eb7aad3ed.tar.gz
LaTeX: fix some documentation from #11224
-rw-r--r--doc/latex.rst33
-rw-r--r--sphinx/texinputs/sphinxpackageboxes.sty2
2 files changed, 25 insertions, 10 deletions
diff --git a/doc/latex.rst b/doc/latex.rst
index ea77a9435..4ed3ad4ab 100644
--- a/doc/latex.rst
+++ b/doc/latex.rst
@@ -1454,10 +1454,11 @@ The ``\sphinxbox`` command
.. versionadded:: 6.2.0
-It can be used to "box" inline text elements with all the customizability which
-has been described in :ref:`additionalcss`. It is a LaTeX command with one
-optional argument, which is a comma-separated list of key=value pairs, as for
-:ref:`latexsphinxsetup`. Here is the complete list of keys:
+The ``\sphinxbox[key=value,...]{inline text}`` command can be used to "box"
+inline text elements with all the customizability which has been described in
+:ref:`additionalcss`. It is a LaTeX command with one optional argument, which
+is a comma-separated list of key=value pairs, as for :ref:`latexsphinxsetup`.
+Here is the complete list of keys:
- ``border-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
``\fboxsep``, rounded corners (with radius ``\fboxsep``) and background and
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_``.
-A utility ``\newsphinxbox`` if provided to create an alternative,
-e.g. ``\foo`` to ``\sphinxbox`` with a different set of defaults, but which
-otherwise behaves the same. Here is a random example of use:
+.. hint::
+
+ 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
@@ -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
-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
~~~~~~~~~~~~
diff --git a/sphinx/texinputs/sphinxpackageboxes.sty b/sphinx/texinputs/sphinxpackageboxes.sty
index 3d71f21c3..d64515603 100644
--- a/sphinx/texinputs/sphinxpackageboxes.sty
+++ b/sphinx/texinputs/sphinxpackageboxes.sty
@@ -15,7 +15,7 @@
% 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
% 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).
% Time to be much simpler and attempt unconditionally to load pict2e
% immediately. This will also have advantage that we can use