[Ksummit-discuss] [CORE TOPIC] Documentation
Marcel Holtmann
marcel at holtmann.org
Tue Aug 4 07:42:55 UTC 2015
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.
Regards
Marcel
More information about the Ksummit-discuss
mailing list