Hi folks! On Mon, Feb 2, 2009 at 7:15 AM, Adriano Marques <[email protected]> wrote: > Hi Bart! > > On Mon, Feb 2, 2009 at 9:12 AM, Bartosz SKOWRON <[email protected]> wrote: >> What kind of documentation? Manual pages? HTML pages? txt? > > That's what I'm proposing to discuss about. What to document, and how. >
I think we could start documenting classes and functions of our own subprojects. I think it's not that hard to do, and it could be a kickstart. I'd like to suggest you to use ReST with Sphinx, which is the python official tools for generating documentation. After that, it could be nice to make help files for Umit at all. We need to think in both sides: the final user side, and the developer side (once Umit is a free software project, we need concern about produce code docs to guide new developers). > > Cheers! > > -- > Adriano Monteiro Marques > > http://adriano-marques.blogspot.com > http://www.umitproject.org > http://www.pythonbenelux.org > > "Don't stay in bed, unless you can make money in bed." - George Burns > > ------------------------------------------------------------------------------ > This SF.net email is sponsored by: > SourcForge Community > SourceForge wants to tell your story. > http://p.sf.net/sfu/sf-spreadtheword > _______________________________________________ > Umit-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/umit-devel > Cheers! -- Rodolfo Carvalho Web Developer [email protected] ------------------------------------------------------------------------------ This SF.net email is sponsored by: SourcForge Community SourceForge wants to tell your story. http://p.sf.net/sfu/sf-spreadtheword _______________________________________________ Umit-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/umit-devel
