IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

uppercase colour names (latex styling)

Browse Source
This commit is contained in:
jfbu 2016-10-30 00:04:23 +02:00
parent a48a9c883a
commit e70746e8da
2 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/latex.rst
View File

@ -16,10 +16,10 @@ The *latex* target does not benefit from pre-prepared themes like the
\begingroup \begingroup
\sphinxsetup{verbatimwithframe=false,% \sphinxsetup{verbatimwithframe=false,%
VerbatimColor={named}{OldLace}, TitleColor={named}{DarkGoldenrod},% VerbatimColor={named}{OldLace}, TitleColor={named}{DarkGoldenrod},%
hintbordercolor={named}{LightCoral}, attentionbgcolor={named}{LightPink},% hintBorderColor={named}{LightCoral}, attentionBgColor={named}{LightPink},%
attentionborder=3pt, attentionbordercolor={named}{Crimson},% attentionborder=3pt, attentionBorderColor={named}{Crimson},%
notebordercolor={named}{Olive}, noteborder=2pt,% noteBorderColor={named}{Olive}, noteborder=2pt,%
cautionbordercolor={named}{Cyan}, cautionbgcolor={named}{LightCyan},% cautionBorderColor={named}{Cyan}, cautionBgColor={named}{LightCyan},%
cautionborder=3pt} cautionborder=3pt}
\relax \relax
@ -111,10 +111,10 @@ If non-empty, it will be passed as argument to the ``\sphinxsetup`` command::
verbatimwithframe=false, verbatimwithframe=false,
VerbatimColor={named}{OldLace}, TitleColor={named}{DarkGoldenrod}, VerbatimColor={named}{OldLace}, TitleColor={named}{DarkGoldenrod},
hintbordercolor={named}{LightCoral}, attentionbgcolor={named}{LightPink}, hintBorderColor={named}{LightCoral}, attentionBgColor={named}{LightPink},
attentionborder=3pt, attentionbordercolor={named}{Crimson}, attentionborder=3pt, attentionBorderColor={named}{Crimson},
notebordercolor={named}{Olive}, noteborder=2pt, noteBorderColor={named}{Olive}, noteborder=2pt,
cautionbordercolor={named}{Cyan}, cautionbgcolor={named}{LightCyan}, cautionBorderColor={named}{Cyan}, cautionBgColor={named}{LightCyan},
cautionborder=3pt cautionborder=3pt
and with the ``svgnames`` option having been passed to "xcolor" package:: and with the ``svgnames`` option having been passed to "xcolor" package::
@ -209,7 +209,7 @@ Here are the currently available options together with their default values.
``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`` ``noteBorderColor``
default ``{rgb}{0,0,0}``. The colour for the two horizontal rules used by default ``{rgb}{0,0,0}``. The colour for the two horizontal rules used by
Sphinx in LaTeX for styling a Sphinx in LaTeX for styling a
:dudir:`note` admonition. Defaults to black. :dudir:`note` admonition. Defaults to black.
@ -217,16 +217,16 @@ Here are the currently available options together with their default values.
.. note:: .. note::
The actual name of the colour as declared to "color" or "xcolor" is The actual name of the colour as declared to "color" or "xcolor" is
``sphinxnotebordercolor``. The same "sphinx" prefix applies to all ``sphinxnoteBorderColor``. The same "sphinx" prefix applies to all
colours for notices and admonitions. colours for notices and admonitions.
``hintbordercolor`` ``hintBorderColor``
default ``{rgb}{0,0,0}``. id. default ``{rgb}{0,0,0}``. id.
``importantbordercolor`` ``importantBorderColor``
default ``{rgb}{0,0,0}``. id. default ``{rgb}{0,0,0}``. id.
``tipbordercolor`` ``tipBorderColor``
default ``{rgb}{0,0,0}``. id. default ``{rgb}{0,0,0}``. id.
``noteborder`` ``noteborder``
@ -241,36 +241,36 @@ Here are the currently available options together with their default values.
``tipborder`` ``tipborder``
default ``0.5pt``. id. default ``0.5pt``. id.
``warningbordercolor`` ``warningBorderColor``
default ``{rgb}{0,0,0}``. The colour of the frame for :dudir:`warning` type default ``{rgb}{0,0,0}``. The colour of the frame for :dudir:`warning` type
admonitions. Defaults to black. admonitions. Defaults to black.
``cautionbordercolor`` ``cautionBorderColor``
default ``{rgb}{0,0,0}``. id. default ``{rgb}{0,0,0}``. id.
``attentionbordercolor`` ``attentionBorderColor``
default ``{rgb}{0,0,0}``. id. default ``{rgb}{0,0,0}``. id.
``dangerbordercolor`` ``dangerBorderColor``
default ``{rgb}{0,0,0}``. id. default ``{rgb}{0,0,0}``. id.
``errorbordercolor`` ``errorBorderColor``
default ``{rgb}{0,0,0}``. id. default ``{rgb}{0,0,0}``. id.
``warningbgcolor`` ``warningBgColor``
default ``{rgb}{1,1,1}``. The background colour for :dudir:`warning` type default ``{rgb}{1,1,1}``. The background colour for :dudir:`warning` type
admonition, defaults to white. admonition, defaults to white.
``cautionbgcolor`` ``cautionBgColor``
default ``{rgb}{1,1,1}``. id. default ``{rgb}{1,1,1}``. id.
``attentionbgcolor`` ``attentionBgColor``
default ``{rgb}{1,1,1}``. id. default ``{rgb}{1,1,1}``. id.
``dangerbgcolor`` ``dangerBgColor``
default ``{rgb}{1,1,1}``. id. default ``{rgb}{1,1,1}``. id.
``errorbgcolor`` ``errorBgColor``
default ``{rgb}{1,1,1}``. id. default ``{rgb}{1,1,1}``. id.
``warningborder`` ``warningborder``

40
sphinx/texinputs/sphinx.sty
View File

@ -131,21 +131,21 @@
\define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}% \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}%
}% }%
% admonition boxes, "light" style % admonition boxes, "light" style
\sphinxDeclareSphinxColorOption{notebordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{hintbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{importantbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{tipbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}}
% admonition boxes, "heavy" style % admonition boxes, "heavy" style
\sphinxDeclareSphinxColorOption{warningbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{cautionbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{attentionbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{dangerbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{errorbordercolor}{{rgb}{0,0,0}} \sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}}
\sphinxDeclareSphinxColorOption{warningbgcolor}{{rgb}{1,1,1}} \sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}}
\sphinxDeclareSphinxColorOption{cautionbgcolor}{{rgb}{1,1,1}} \sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}}
\sphinxDeclareSphinxColorOption{attentionbgcolor}{{rgb}{1,1,1}} \sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}}
\sphinxDeclareSphinxColorOption{dangerbgcolor}{{rgb}{1,1,1}} \sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}}
\sphinxDeclareSphinxColorOption{errorbgcolor}{{rgb}{1,1,1}} \sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}}
\DeclareDefaultOption{\@unknownoptionerror} \DeclareDefaultOption{\@unknownoptionerror}
\ProcessKeyvalOptions* \ProcessKeyvalOptions*
@ -689,10 +689,10 @@
% these are needed for common handling by notice environment of lightbox % these are needed for common handling by notice environment of lightbox
% and heavybox but they are currently not used by lightbox environment % and heavybox but they are currently not used by lightbox environment
% and there is consequently no corresponding package option % and there is consequently no corresponding package option
\definecolor{sphinxnotebgcolor}{rgb}{1,1,1} \definecolor{sphinxnoteBgColor}{rgb}{1,1,1}
\definecolor{sphinxhintbgcolor}{rgb}{1,1,1} \definecolor{sphinxhintBgColor}{rgb}{1,1,1}
\definecolor{sphinximportantbgcolor}{rgb}{1,1,1} \definecolor{sphinimportantBgColor}{rgb}{1,1,1}
\definecolor{sphinxtipbgcolor}{rgb}{1,1,1} \definecolor{sphinxtipBgColor}{rgb}{1,1,1}
% Others get more distinction % Others get more distinction
% Code adapted from framed.sty's "snugshade" environment. % Code adapted from framed.sty's "snugshade" environment.
@ -766,8 +766,8 @@
% can't use #1 directly in definition of end part % can't use #1 directly in definition of end part
\def\spx@noticetype {#1}% \def\spx@noticetype {#1}%
% set parameters of heavybox/lightbox % set parameters of heavybox/lightbox
\sphinxcolorlet{spx@notice@bordercolor}{sphinx#1bordercolor}% \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1BorderColor}%
\sphinxcolorlet{spx@notice@bgcolor}{sphinx#1bgcolor}% \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1BgColor}%
\spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax \spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax
% start specific environment, passing the heading as argument % start specific environment, passing the heading as argument
\begin{sphinx#1}{#2}} \begin{sphinx#1}{#2}}