diff --git a/doc/latex.rst b/doc/latex.rst index f6d36184a..fda80b33d 100644 --- a/doc/latex.rst +++ b/doc/latex.rst @@ -16,10 +16,10 @@ The *latex* target does not benefit from pre-prepared themes like the \begingroup \sphinxsetup{verbatimwithframe=false,% VerbatimColor={named}{OldLace}, TitleColor={named}{DarkGoldenrod},% - hintbordercolor={named}{LightCoral}, attentionbgcolor={named}{LightPink},% - attentionborder=3pt, attentionbordercolor={named}{Crimson},% - notebordercolor={named}{Olive}, noteborder=2pt,% - cautionbordercolor={named}{Cyan}, cautionbgcolor={named}{LightCyan},% + hintBorderColor={named}{LightCoral}, attentionBgColor={named}{LightPink},% + attentionborder=3pt, attentionBorderColor={named}{Crimson},% + noteBorderColor={named}{Olive}, noteborder=2pt,% + cautionBorderColor={named}{Cyan}, cautionBgColor={named}{LightCyan},% cautionborder=3pt} \relax @@ -111,10 +111,10 @@ If non-empty, it will be passed as argument to the ``\sphinxsetup`` command:: verbatimwithframe=false, VerbatimColor={named}{OldLace}, TitleColor={named}{DarkGoldenrod}, - hintbordercolor={named}{LightCoral}, attentionbgcolor={named}{LightPink}, - attentionborder=3pt, attentionbordercolor={named}{Crimson}, - notebordercolor={named}{Olive}, noteborder=2pt, - cautionbordercolor={named}{Cyan}, cautionbgcolor={named}{LightCyan}, + hintBorderColor={named}{LightCoral}, attentionBgColor={named}{LightPink}, + attentionborder=3pt, attentionBorderColor={named}{Crimson}, + noteBorderColor={named}{Olive}, noteborder=2pt, + cautionBorderColor={named}{Cyan}, cautionBgColor={named}{LightCyan}, cautionborder=3pt 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`` 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 Sphinx in LaTeX for styling a :dudir:`note` admonition. Defaults to black. @@ -217,16 +217,16 @@ Here are the currently available options together with their default values. .. note:: 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. -``hintbordercolor`` +``hintBorderColor`` default ``{rgb}{0,0,0}``. id. -``importantbordercolor`` +``importantBorderColor`` default ``{rgb}{0,0,0}``. id. -``tipbordercolor`` +``tipBorderColor`` default ``{rgb}{0,0,0}``. id. ``noteborder`` @@ -241,36 +241,36 @@ Here are the currently available options together with their default values. ``tipborder`` default ``0.5pt``. id. -``warningbordercolor`` +``warningBorderColor`` default ``{rgb}{0,0,0}``. The colour of the frame for :dudir:`warning` type admonitions. Defaults to black. -``cautionbordercolor`` +``cautionBorderColor`` default ``{rgb}{0,0,0}``. id. -``attentionbordercolor`` +``attentionBorderColor`` default ``{rgb}{0,0,0}``. id. -``dangerbordercolor`` +``dangerBorderColor`` default ``{rgb}{0,0,0}``. id. -``errorbordercolor`` +``errorBorderColor`` default ``{rgb}{0,0,0}``. id. -``warningbgcolor`` +``warningBgColor`` default ``{rgb}{1,1,1}``. The background colour for :dudir:`warning` type admonition, defaults to white. -``cautionbgcolor`` +``cautionBgColor`` default ``{rgb}{1,1,1}``. id. -``attentionbgcolor`` +``attentionBgColor`` default ``{rgb}{1,1,1}``. id. -``dangerbgcolor`` +``dangerBgColor`` default ``{rgb}{1,1,1}``. id. -``errorbgcolor`` +``errorBgColor`` default ``{rgb}{1,1,1}``. id. ``warningborder`` diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index 62714be70..f6f677cc9 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -131,21 +131,21 @@ \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}% }% % admonition boxes, "light" style -\sphinxDeclareSphinxColorOption{notebordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{hintbordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{importantbordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{tipbordercolor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}} % admonition boxes, "heavy" style -\sphinxDeclareSphinxColorOption{warningbordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{cautionbordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{attentionbordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{dangerbordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{errorbordercolor}{{rgb}{0,0,0}} -\sphinxDeclareSphinxColorOption{warningbgcolor}{{rgb}{1,1,1}} -\sphinxDeclareSphinxColorOption{cautionbgcolor}{{rgb}{1,1,1}} -\sphinxDeclareSphinxColorOption{attentionbgcolor}{{rgb}{1,1,1}} -\sphinxDeclareSphinxColorOption{dangerbgcolor}{{rgb}{1,1,1}} -\sphinxDeclareSphinxColorOption{errorbgcolor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}} \DeclareDefaultOption{\@unknownoptionerror} \ProcessKeyvalOptions* @@ -689,10 +689,10 @@ % these are needed for common handling by notice environment of lightbox % and heavybox but they are currently not used by lightbox environment % and there is consequently no corresponding package option -\definecolor{sphinxnotebgcolor}{rgb}{1,1,1} -\definecolor{sphinxhintbgcolor}{rgb}{1,1,1} -\definecolor{sphinximportantbgcolor}{rgb}{1,1,1} -\definecolor{sphinxtipbgcolor}{rgb}{1,1,1} +\definecolor{sphinxnoteBgColor}{rgb}{1,1,1} +\definecolor{sphinxhintBgColor}{rgb}{1,1,1} +\definecolor{sphinimportantBgColor}{rgb}{1,1,1} +\definecolor{sphinxtipBgColor}{rgb}{1,1,1} % Others get more distinction % Code adapted from framed.sty's "snugshade" environment. @@ -766,8 +766,8 @@ % can't use #1 directly in definition of end part \def\spx@noticetype {#1}% % set parameters of heavybox/lightbox - \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1bordercolor}% - \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1bgcolor}% + \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1BorderColor}% + \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1BgColor}% \spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax % start specific environment, passing the heading as argument \begin{sphinx#1}{#2}}