in sphinx docs, what is "@b barebox" markup supposed to do?
s.hauer at pengutronix.de
Mon Jun 30 05:56:32 PDT 2014
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.
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.
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 |
More information about the barebox