* in sphinx docs, what is "@b barebox" markup supposed to do?
@ 2014-06-28 13:06 Robert P. J. Day
2014-06-30 6:01 ` Sascha Hauer
0 siblings, 1 reply; 6+ messages in thread
From: Robert P. J. Day @ 2014-06-28 13:06 UTC (permalink / raw)
To: U-Boot Version 2 (barebox)
a number of places in the docs contain the markup "@b barebox". how
is that supposed to render? it just shows up as, verbatim, "@b
barebox" (see, for example, the board page for chumbyone).
thoughts?
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: in sphinx docs, what is "@b barebox" markup supposed to do?
2014-06-28 13:06 in sphinx docs, what is "@b barebox" markup supposed to do? Robert P. J. Day
@ 2014-06-30 6:01 ` Sascha Hauer
2014-06-30 9:38 ` Holger Schurig
0 siblings, 1 reply; 6+ messages in thread
From: Sascha Hauer @ 2014-06-30 6:01 UTC (permalink / raw)
To: Robert P. J. Day; +Cc: U-Boot Version 2 (barebox)
On Sat, Jun 28, 2014 at 09:06:27AM -0400, Robert P. J. Day wrote:
>
> a number of places in the docs contain the markup "@b barebox". how
> is that supposed to render? it just shows up as, verbatim, "@b
> barebox" (see, for example, the board page for chumbyone).
I think it's doxygen for bold text. We should just drop this.
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: in sphinx docs, what is "@b barebox" markup supposed to do?
2014-06-30 6:01 ` Sascha Hauer
@ 2014-06-30 9:38 ` Holger Schurig
2014-06-30 9:56 ` Robert P. J. Day
2014-06-30 12:50 ` Robert P. J. Day
0 siblings, 2 replies; 6+ messages in thread
From: Holger Schurig @ 2014-06-30 9:38 UTC (permalink / raw)
To: Sascha Hauer; +Cc: U-Boot Version 2 (barebox)
I found a Sphinx cheat sheet:
http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html
(where you have all the important things on just one page).
So you can convert "This is @b foo bar" to "This is **foo** bar".
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: in sphinx docs, what is "@b barebox" markup supposed to do?
2014-06-30 9:38 ` Holger Schurig
@ 2014-06-30 9:56 ` Robert P. J. Day
2014-06-30 12:56 ` Sascha Hauer
2014-06-30 12:50 ` Robert P. J. Day
1 sibling, 1 reply; 6+ messages in thread
From: Robert P. J. Day @ 2014-06-30 9:56 UTC (permalink / raw)
To: Holger Schurig; +Cc: U-Boot Version 2 (barebox)
On Mon, 30 Jun 2014, Holger Schurig wrote:
> I found a Sphinx cheat sheet:
> http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html
> (where you have all the important things on just one page).
>
> So you can convert "This is @b foo bar" to "This is **foo** bar".
except the standard *seems* to be to not mark up the name "barebox"
at all, so it would seem more appropriate to just remove the doxygen
markup for the word "barebox" entirely.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: in sphinx docs, what is "@b barebox" markup supposed to do?
2014-06-30 9:56 ` Robert P. J. Day
@ 2014-06-30 12:56 ` Sascha Hauer
0 siblings, 0 replies; 6+ messages in thread
From: Sascha Hauer @ 2014-06-30 12:56 UTC (permalink / raw)
To: Robert P. J. Day; +Cc: U-Boot Version 2 (barebox)
On Mon, Jun 30, 2014 at 05:56:37AM -0400, Robert P. J. Day wrote:
> On Mon, 30 Jun 2014, Holger Schurig wrote:
>
> > I found a Sphinx cheat sheet:
> > http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html
> > (where you have all the important things on just one page).
> >
> > So you can convert "This is @b foo bar" to "This is **foo** bar".
>
> except the standard *seems* to be to not mark up the name "barebox"
> at all, so it would seem more appropriate to just remove the doxygen
> markup for the word "barebox" entirely.
Yes.
IMO it doesn't help the reader if every occurrence of the word
**barebox** in a **barebox** manual is in bold letters just because we
like **barebox** so much.
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: in sphinx docs, what is "@b barebox" markup supposed to do?
2014-06-30 9:38 ` Holger Schurig
2014-06-30 9:56 ` Robert P. J. Day
@ 2014-06-30 12:50 ` Robert P. J. Day
1 sibling, 0 replies; 6+ messages in thread
From: Robert P. J. Day @ 2014-06-30 12:50 UTC (permalink / raw)
To: Holger Schurig; +Cc: U-Boot Version 2 (barebox)
On Mon, 30 Jun 2014, Holger Schurig wrote:
> I found a Sphinx cheat sheet:
> http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html
> (where you have all the important things on just one page).
>
> So you can convert "This is @b foo bar" to "This is **foo** bar".
hmmmmm ... a handy page but i'm puzzled by one of the first things
listed there; that is, that double backquotes are used to make a text
"verbatim". it also appears to render it in courier, which is what i
use to represent things like commands, filenames, etc.
other than that, that's a nice cheat sheet, thanks.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2014-06-30 12:56 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-06-28 13:06 in sphinx docs, what is "@b barebox" markup supposed to do? Robert P. J. Day
2014-06-30 6:01 ` Sascha Hauer
2014-06-30 9:38 ` Holger Schurig
2014-06-30 9:56 ` Robert P. J. Day
2014-06-30 12:56 ` Sascha Hauer
2014-06-30 12:50 ` Robert P. J. Day
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox