New Documentation for barebox
Robert P. J. Day
rpjday at crashcourse.ca
Thu Jun 26 03:31:10 PDT 2014
On Thu, 26 Jun 2014, Sascha Hauer wrote:
> Hi all,
> I am happy to announce new documentation for barebox.
> The following series removes the in-tree documentation and replaces
> it with completely rewritten sphinxs based documentation. As of now
> we have a more or less complete user manual. There surely is room
> for improvements but we think that it is good enough already and
> surely better than what we have now.
> The documentation is written with Sphinx. Sphinx is
> the Python Documentation Generator, see http://sphinx-doc.org/.
> The files are written in reStructuredText, a format which is
> sufficiently easy to write and nice to read even in sourcecode
> Thank you Jan, Lukas and Jochen for help writing documentation and
> fixing typos.
> `make docs` will generate static html files.
... snip ...
couple quick observations before i put on my editor hat and go
through all this. first, on my fedora rawhide system, running "make
docs" generates quite a few warnings, although the HTML is eventually
built. is it worth digging into the doc generation warnings and trying
to clean them up? anyone else building the docs on fedora rawhide and
see what i'm talking about?
and just from the main page, a couple very pedantic questions:
* should the name "Barebox" be italicized or not? it seems even that
single page bounces back and forth using and not using "@a" in front
of the word "Barebox".
* the "Directory layout" section inserts a space on either side of the
"/" in directory names, as in:
arch / * /
that just looks ... weird.
* oh, final note regarding name "Barebox", i notice some pages (like
the x86_bootloader page) use the uncapitalized name "barebox" -- this
really should be consistent throughout all the docs.
more later after i read more ...
Robert P. J. Day Ottawa, Ontario, CANADA
More information about the barebox