[SR-Dev] Module Documentation

Martin Hoffmann martin.hoffmann at telio.ch
Tue Apr 21 10:34:40 CEST 2009


Juha Heinanen wrote:
> Martin Hoffmann writes:
> 
>  > The Python people use RST everywhere -- the entire documentation
>  > basically is RST files (on docs.python.org you can even check the raw
>  > files). While I am personally not too fond of RST, it would be a good
>  > choice since obviously processing the stuff in Python is easy.
>  > 
>  > If we then define the required sections in the README file, we can write
>  > a little script for turning it into nroff or docbook or whatever.
> 
> fine, but how to turn current k module docs into that format?

Manually and over time.

Regards,
Martin



More information about the sr-dev mailing list