Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[LaTeX] [DOC] Update docs relative to admonition colors #12588

Merged
merged 1 commit into from
Jul 15, 2024
Merged

[LaTeX] [DOC] Update docs relative to admonition colors #12588

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions doc/latex.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1304,14 +1304,24 @@ forget the underscore separating the prefix from the property names.
| ``<prefix>_TeXcolor``.
These are colors.

The shadow color defaults in all cases to ``{rgb}{0,0,0}`` i.e. to black.
Since 6.0.0 the border and background colors of :rst:dir:`code-block`,
default respectively to ``{RGB}{32,32,32}`` (i.e. ``{HTML}{202020}``), and
``{RGB}{242,242,242}`` (i.e. ``{gray}{0.95}`` or ``{HTML}{F2F2F2}``).

Since 6.0.0 the border color and background color of :rst:dir:`code-block`,
i.e. ``pre`` prefix, default respectively to ``{RGB}{32,32,32}`` and
``{gray}{0.95}``. They previously defaulted to black, respectively white.
At 7.4.0 other directives acquire non-black/white default border and
background colors. Here they are using ``xcolor`` hexadecimal notation
(which requires always 6 hexadecimal digits):

For all other types, the border color defaults to black and the background
color to white.
- ``{HTML}{F7F7F7}`` serves as background color to all.
- ``{HTML}{86989B}`` is border color of light admonitions (inclusive of
:rst:dir:`seealso` and :rst:dir:`todo`) as well as of :dudir:`topic` and
contents_ directives.
- ``{HTML}{940000}`` is border color or :dudir:`warning`-type admonitions,
except :dudir:`error` which uses ``{HTML}{B40000}``.

The only directives displaying a shadow per default are :dudir:`topic` and
contents_ (handled identically at LaTeX level) and their shadow color is
``{HTML}{6C6C6C}``. For all others the default shadow color is black.

The ``<prefix>_TeXcolor`` stands for the CSS property "color", i.e. it
influences the text color of the contents. As for the three other options,
Expand All @@ -1330,7 +1340,6 @@ forget the underscore separating the prefix from the property names.
start of the contents; for admonitions, this happens after the heading which
reproduces the admonition type.


The next keys, for admonitions only, were all three added at 7.4.0. The
default colors are the ones applying to the current HTML rendering of Sphinx
own docs at https://www.sphinx-doc.org.
Expand Down