== Documentation == As per the Python standard, we use [http://epydoc.sourceforge.net/docstrings.html DocStrings] to document each function/class.[[BR]] These can be queried on the command line: {{{ >>> print myfunction.__doc__ }}} They are also used by [http://epydoc.sourceforge.net Epydoc] to generate our [http://epydoc.sahanapy.org API documentation]. Individual routines inside functions should still have comments to explain them. [wiki:InstallationGuidelines User Guides] & [wiki:DeveloperGuidelines Developer Guides] are written on the Wiki.[[BR]] Trac 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. To generate a PDF version with low work, we could look to use: * http://trac-hacks.org/wiki/TracWikiToPdfPlugin ---- DeveloperGuidelines