Changes between Initial Version and Version 1 of DeveloperGuidelines/Documentation


Ignore:
Timestamp:
01/24/09 12:14:18 (13 years ago)
Author:
Fran Boon
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/Documentation

    v1 v1  
     1== Documentation ==
     2As per the Python standard, we use [http://epydoc.sourceforge.net/docstrings.html DocStrings] to document each function/class.[[BR]]
     3These can be queried on the command line:
     4{{{
     5>>> print myfunction.__doc__
     6}}}
     7They are also used by [http://epydoc.sourceforge.net Epydoc] to generate our [http://epydoc.sahanapy.org API documentation].
     8
     9Individual routines inside functions should still have comments to explain them.
     10
     11[wiki:InstallationGuidelines User Guides] & [wiki:DeveloperGuidelines Developer Guides] are written on the Wiki.[[BR]]
     12Trac can be [wiki:BluePrintTrac enhanced] to make it's Wiki more usable, otherwise we may switch to [http://www.dokuwiki.org DokuWiki] for the User Guides.
     13
     14To generate a PDF version with low work, we could look to use:
     15 * http://trac-hacks.org/wiki/TracWikiToPdfPlugin
     16----
     17DeveloperGuidelines