* [PATCH 1/2] docs-rst: Use better colors for note/warning/attention boxes
2016-08-21 18:23 [PATCH 0/2] Two additional patches for Documentation/conf.py Mauro Carvalho Chehab
@ 2016-08-21 18:23 ` Mauro Carvalho Chehab
2016-08-21 18:23 ` [PATCH 2/2] docs-rst: Fix an warning when in interactive mode Mauro Carvalho Chehab
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2016-08-21 18:23 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
linux-doc
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>
---
Documentation/conf.py | 34 ++++++++++++++++++++++++----------
1 file changed, 24 insertions(+), 10 deletions(-)
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 011f6dac0c6c..f71b71048e37 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
--
2.7.4
^ permalink raw reply related [flat|nested] 3+ messages in thread* [PATCH 2/2] docs-rst: Fix an warning when in interactive mode
2016-08-21 18:23 [PATCH 0/2] Two additional patches for Documentation/conf.py Mauro Carvalho Chehab
2016-08-21 18:23 ` [PATCH 1/2] docs-rst: Use better colors for note/warning/attention boxes Mauro Carvalho Chehab
@ 2016-08-21 18:23 ` Mauro Carvalho Chehab
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2016-08-21 18:23 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
linux-doc
When XeLaTeX is in interactive mode, it complains that
py@noticelength already exists. Rename it and declare it
only once to avoid such messages.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/conf.py | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/conf.py b/Documentation/conf.py
index f71b71048e37..42045c26581b 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -282,14 +282,14 @@ latex_elements = {
\\definecolor{WarningColor}{RGB}{255,204,204}
\\definecolor{AttentionColor}{RGB}{255,255,204}
\\definecolor{OtherColor}{RGB}{204,204,204}
+ \\newlength{\\mynoticelength}
\\makeatletter\\newenvironment{coloredbox}[1]{%
- \\newlength{\\py@noticelength}
\\setlength{\\fboxrule}{1pt}
\\setlength{\\fboxsep}{7pt}
- \\setlength{\\py@noticelength}{\\linewidth}
- \\addtolength{\\py@noticelength}{-2\\fboxsep}
- \\addtolength{\\py@noticelength}{-2\\fboxrule}
- \\begin{lrbox}{\\@tempboxa}\\begin{minipage}{\\py@noticelength}}{\\end{minipage}\\end{lrbox}%
+ \\setlength{\\mynoticelength}{\\linewidth}
+ \\addtolength{\\mynoticelength}{-2\\fboxsep}
+ \\addtolength{\\mynoticelength}{-2\\fboxrule}
+ \\begin{lrbox}{\\@tempboxa}\\begin{minipage}{\\mynoticelength}}{\\end{minipage}\\end{lrbox}%
\\ifthenelse%
{\\equal{\\py@noticetype}{note}}%
{\\colorbox{NoteColor}{\\usebox{\\@tempboxa}}}%
--
2.7.4
^ permalink raw reply related [flat|nested] 3+ messages in thread