Re: [Ksummit-discuss] [CORE TOPIC] Documentation

[Peter Huewe <peterhuewe@gmx.de>]

Hi

Am 4. August 2015 09:42:55 MESZ, schrieb Marcel Holtmann <marcel@holtmann.org>:
>Hi Michael,
>
>>> Markdown in one of its many forms might be a good alternative here. 
>I'm
>>> also somewhat attracted by Sphinx, which is designed for documenting
>code
>>> already and could probably be made to work well with our existing
>kerneldoc
>>> comments without a whole lot of trouble.  The Sphinx idea, though,
>is
>>> hobbled by the inconvenient fact that I've not had the time to
>develop it
>>> far enough to even have a vague idea of whether it would make
>real-world
>>> sense.
>> 
>> I'd vote for Markdown. It's very unobtrusive, reads nicely as plain
>text, and
>> all the young kids know it from writing Github README.md files.
>
>actually AsciiDoc might be something to look into as well.
>
I'm also in for AsciiDoc, as it also allows easy generation of Pdfs and html files, with chapters and all that fancy stuff.

(Probably the reason why docbook was chosen back then, compared to the plaintext files)

Peter
-- 
Sent from my mobile