Changes

Jump to: navigation, search

Programming guidelines

23 bytes removed, 04:01, 28 December 2012
m
Docstrings: update link
* Python provides a docstrings to document classes and functions. If the class is a class used by others (such as the [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib gen lib] classes), the docstrings should follow the restructuredtext ([http://docutils.sourceforge.net/docs/user/rst/quickstart.html#structure rst]) format. This allows us to extract [http://www.gramps-project.org/docs/ API] documentation using sphinx.
* Apart from adding doc strings to classes and functions, also the api generating rst files must be edited so as to extract the documentation. These files are in the [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/docs/ docs directory], for info read the [http://grampssvn.svncode.sourceforgesf.net/viewvcp/gramps/code/trunk/docs/README.txt?view=markup README.txt] file.
:More info

Navigation menu