[ptxdist] [PATCH v2] doc: highlight inline code with gray box

[ptxdist] [PATCH v2] doc: highlight inline code with gray box

[Enrico Jorns]

This should ease distinguishing inline code snippets from default text
and is also more similar to what the sphinx html outputs look like.

Signed-off-by: Enrico Jorns <ejo@pengutronix.de>
---

Changes in v2:

* use same background and border style as non-inline code boxes
* reduce fbox inner separation for better inline experience

 doc/preamble.inc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/preamble.inc b/doc/preamble.inc
index d9e528ef4..0e632c3d2 100644
--- a/doc/preamble.inc
+++ b/doc/preamble.inc
@@ -82,6 +82,9 @@
 \definecolor{VerbatimColor}{gray}{0.95}
 \definecolor{VerbatimBorderColor}{gray}{0.75}
 
+% override default sphinxcode to display gray-colored box
+\protected\def\sphinxcode#1{\fboxsep0.5mm\fcolorbox{VerbatimBorderColor}{VerbatimColor}{\texttt{#1}}}
+
 \makeatother
 
 % vim:syntax=tex
-- 
2.28.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

Re: [ptxdist] [PATCH v2] doc: highlight inline code with gray box

[Michael Olbrich]

On Fri, Sep 11, 2020 at 12:32:04PM +0200, Enrico Jorns wrote:
> This should ease distinguishing inline code snippets from default text
> and is also more similar to what the sphinx html outputs look like.

I prefer this. Any other opinions?

Michael

> Signed-off-by: Enrico Jorns <ejo@pengutronix.de>
> ---
> 
> Changes in v2:
> 
> * use same background and border style as non-inline code boxes
> * reduce fbox inner separation for better inline experience
> 
>  doc/preamble.inc | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/doc/preamble.inc b/doc/preamble.inc
> index d9e528ef4..0e632c3d2 100644
> --- a/doc/preamble.inc
> +++ b/doc/preamble.inc
> @@ -82,6 +82,9 @@
>  \definecolor{VerbatimColor}{gray}{0.95}
>  \definecolor{VerbatimBorderColor}{gray}{0.75}
>  
> +% override default sphinxcode to display gray-colored box
> +\protected\def\sphinxcode#1{\fboxsep0.5mm\fcolorbox{VerbatimBorderColor}{VerbatimColor}{\texttt{#1}}}
> +
>  \makeatother
>  
>  % vim:syntax=tex
> -- 
> 2.28.0
> 
> 
> _______________________________________________
> ptxdist mailing list
> ptxdist@pengutronix.de
> To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

Re: [ptxdist] [PATCH v2] doc: highlight inline code with gray box

[Roland Hieber]

On Fri, Sep 11, 2020 at 04:40:08PM +0200, Michael Olbrich wrote:
> On Fri, Sep 11, 2020 at 12:32:04PM +0200, Enrico Jorns wrote:
> > This should ease distinguishing inline code snippets from default text
> > and is also more similar to what the sphinx html outputs look like.
> 
> I prefer this. Any other opinions?

Looks good to me.

 - Roland

> > Signed-off-by: Enrico Jorns <ejo@pengutronix.de>
> > ---
> > 
> > Changes in v2:
> > 
> > * use same background and border style as non-inline code boxes
> > * reduce fbox inner separation for better inline experience
> > 
> >  doc/preamble.inc | 3 +++
> >  1 file changed, 3 insertions(+)
> > 
> > diff --git a/doc/preamble.inc b/doc/preamble.inc
> > index d9e528ef4..0e632c3d2 100644
> > --- a/doc/preamble.inc
> > +++ b/doc/preamble.inc
> > @@ -82,6 +82,9 @@
> >  \definecolor{VerbatimColor}{gray}{0.95}
> >  \definecolor{VerbatimBorderColor}{gray}{0.75}
> >  
> > +% override default sphinxcode to display gray-colored box
> > +\protected\def\sphinxcode#1{\fboxsep0.5mm\fcolorbox{VerbatimBorderColor}{VerbatimColor}{\texttt{#1}}}
> > +
> >  \makeatother
> >  
> >  % vim:syntax=tex
> > -- 
> > 2.28.0
> > 
> > 
> > _______________________________________________
> > ptxdist mailing list
> > ptxdist@pengutronix.de
> > To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de
> > 
> 
> -- 
> Pengutronix e.K.                           |                             |
> Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
> 31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
> Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |
> 
> _______________________________________________
> ptxdist mailing list
> ptxdist@pengutronix.de
> To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de
> 

-- 
Roland Hieber, Pengutronix e.K.          | r.hieber@pengutronix.de     |
Steuerwalder Str. 21                     | https://www.pengutronix.de/ |
31137 Hildesheim, Germany                | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686         | Fax:   +49-5121-206917-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

Re: [ptxdist] [APPLIED] doc: highlight inline code with gray box

[Michael Olbrich]

Thanks, applied as 25e4de8af9b9576d337b6f9a465d54ccbe55614a.

Michael

[sent from post-receive hook]

On Tue, 06 Oct 2020 10:18:33 +0200, Enrico Jorns <ejo@pengutronix.de> wrote:
> This should ease distinguishing inline code snippets from default text
> and is also more similar to what the sphinx html outputs look like.
> 
> Signed-off-by: Enrico Jorns <ejo@pengutronix.de>
> Message-Id: <20200911103204.9745-1-ejo@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> diff --git a/doc/preamble.inc b/doc/preamble.inc
> index d9e528ef4108..0e632c3d2736 100644
> --- a/doc/preamble.inc
> +++ b/doc/preamble.inc
> @@ -82,6 +82,9 @@
>  \definecolor{VerbatimColor}{gray}{0.95}
>  \definecolor{VerbatimBorderColor}{gray}{0.75}
>  
> +% override default sphinxcode to display gray-colored box
> +\protected\def\sphinxcode#1{\fboxsep0.5mm\fcolorbox{VerbatimBorderColor}{VerbatimColor}{\texttt{#1}}}
> +
>  \makeatother
>  
>  % vim:syntax=tex

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de