summaryrefslogtreecommitdiff
path: root/Documentation/conf.py
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-21 21:23:03 +0300
committerJonathan Corbet <corbet@lwn.net>2016-08-23 00:34:48 +0300
commit41cff161fe99d1c6a773becc2250a1dc3ac035ff (patch)
tree8b57fbc88d1dac23c1c621ed50e03699af7e4175 /Documentation/conf.py
parentaa4e37a3d13679dccf7945dd864375b698cf0df9 (diff)
downloadlinux-41cff161fe99d1c6a773becc2250a1dc3ac035ff.tar.xz
docs-rst: Use better colors for note/warning/attention boxes
Instead of painting the box with gray, let's use a colored box. IMHO, that makes easier to warn users about some issue pointed by the Sphinx. It also matches to what we do already with the HTML output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/conf.py')
-rw-r--r--Documentation/conf.py34
1 files changed, 24 insertions, 10 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py
index aaa3f70aafcb..2a02a817b1a0 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -277,11 +277,12 @@ latex_elements = {
% Allow generate some pages in landscape
\\usepackage{lscape}
- % Put notes in gray color and let them be inside a table
-
- \\definecolor{MyGray}{rgb}{0.80,0.80,0.80}
-
- \\makeatletter\\newenvironment{graybox}{%
+ % Put notes in color and let them be inside a table
+ \\definecolor{NoteColor}{RGB}{204,255,255}
+ \\definecolor{WarningColor}{RGB}{255,204,204}
+ \\definecolor{AttentionColor}{RGB}{255,255,204}
+ \\definecolor{OtherColor}{RGB}{204,204,204}
+ \\makeatletter\\newenvironment{coloredbox}[1]{%
\\newlength{\\py@noticelength}
\\setlength{\\fboxrule}{1pt}
\\setlength{\\fboxsep}{7pt}
@@ -289,20 +290,33 @@ latex_elements = {
\\addtolength{\\py@noticelength}{-2\\fboxsep}
\\addtolength{\\py@noticelength}{-2\\fboxrule}
\\begin{lrbox}{\\@tempboxa}\\begin{minipage}{\\py@noticelength}}{\\end{minipage}\\end{lrbox}%
- \\colorbox{MyGray}{\\usebox{\\@tempboxa}}
+ \\ifthenelse%
+ {\\equal{\\py@noticetype}{note}}%
+ {\\colorbox{NoteColor}{\\usebox{\\@tempboxa}}}%
+ {%
+ \\ifthenelse%
+ {\\equal{\\py@noticetype}{warning}}%
+ {\\colorbox{WarningColor}{\\usebox{\\@tempboxa}}}%
+ {%
+ \\ifthenelse%
+ {\\equal{\\py@noticetype}{attention}}%
+ {\\colorbox{AttentionColor}{\\usebox{\\@tempboxa}}}%
+ {\\colorbox{OtherColor}{\\usebox{\\@tempboxa}}}%
+ }%
+ }%
}\\makeatother
\\makeatletter
- \\renewenvironment{notice}[2]{
- \\begin{graybox}
- \\bf\\it
+ \\renewenvironment{notice}[2]{%
\\def\\py@noticetype{#1}
+ \\begin{coloredbox}{#1}
+ \\bf\\it
\\par\\strong{#2}
\\csname py@noticestart@#1\\endcsname
}
{
\\csname py@noticeend@\\py@noticetype\\endcsname
- \\end{graybox}
+ \\end{coloredbox}
}
\\makeatother