barebox Documentation

[Baruch Siach]

Hi Sascha,

On Tue, May 13, 2014 at 04:18:35PM +0200, Sascha Hauer wrote:
> On Tue, May 13, 2014 at 04:01:07PM +0200, Holger Schurig wrote:
> > If wiki and doxygen are not updated, than this is a sign that they
> > should probably be outphased.
> > 
> > Instead, I'd prefer to have text files in the Documentation/ tree. So
> > changes to them pass the normal review process.
> 
> +1
> 
> > > Plain text files
> > > - no links
> > > - no pictures
> > 
> > If we use some special format for them, e.g. Markdown or *.rst, then
> > the files can still converted to HTML, and links and images could
> > still be possible. That would mean that wiki.barebox.org probably goes
> > away, but that (part) of www.barebox.org is generated from the
> > *.rst/Markdown files.
> 
> This sounds like the best of two worlds. Do you know an example of a
> project with markdown/rst documentation?

Buildroot generates its manual from in-tree AsciiDoc formatted files under 
docs/manual/. PDF, HTML, epub, and text output formats are supported. See 
http://buildroot.net/docs.html for the generated result. See 
docs/manual/manual.mk (included from the top level Makefile) for the build 
recipes.

baruch

-- 
     http://baruch.siach.name/blog/                  ~. .~   Tk Open Systems
=}------------------------------------------------ooO--U--Ooo------------{=
   - baruch at tkos.co.il - tel: +972.2.679.5364, http://www.tkos.co.il -