gramps

History

Nick Hall 80d73f058c Remove remaining make files svn: r20980		2013-01-04 18:08:04 +00:00
..
corecli	update API documentation (3.4)	2012-02-20 15:04:41 +00:00
coregui	specific import path for generating GUI section	2012-12-03 15:15:42 +00:00
gen	typo; missing gen.utils.alive module	2012-07-22 05:44:34 +00:00
api.rst	update APIs documentation according to last changes (GEPS008)	2012-07-19 08:55:23 +00:00
conf.py	GEP008: update references for documentation	2012-11-30 10:00:48 +00:00
date.rst	specific import path for Date Editor	2012-12-03 15:39:03 +00:00
developer_guide.rst
html.rst
index.rst
README.txt	fix typo	2009-08-22 21:45:34 +00:00
relationship.rst	update APIs documentation according to last changes (GEPS008)	2012-07-19 08:55:23 +00:00
simple.rst	update APIs documentation according to last changes (GEPS008)	2012-07-19 08:55:23 +00:00
update_doc.py	start a quick alternative to Makefile builder for API documentations	2012-12-01 11:35:07 +00:00
user_guide.rst

README.txt

Installation and building the docs
==================================

You need to install sphinx. Assuming you have installed the python setuptools, just do:

  sudo easy_install sphinx 

Once installed, go to the docs directory, and do:

  make html

Which will produce the html output in docs/_build/html


Documentation Guidelines
=======================

Doc strings in python files should be written in reStructured text: http://docutils.sourceforge.net/docs/user/rst/quickref.html

The typical docstring for GRAMPS should look like this: 

"""Brief synopsis

This is a longer explanation, which may include  *italics* or **bold**, or
a link to another method :meth:`~gen.lib.person.Person.get_handle`
Then, you need to provide optional subsection in this order (just to be
consistent and have a uniform documentation, nothing prevent you to switch
the order). 

:param arg1: the first value
:type arg1: int or float or :class:`~gen.lib.baseobj.BaseObject`
:param arg2: the second value
:type arg2: int or float 
:param arg3: the third value
         
:returns: arg1/arg2 +arg3
:rtype: float, this is the return type
            
       
:Examples:

>>> import template
>>> a = MainClass()
>>> a.function2(1,1,1)
2

:note:
    can be useful to emphasize
    important feature

:See Also:
    :class:`MainClass1`
       
:Warnings:
    arg2 must be non-zero.
            
:Todo:
   check that arg2 is non zero. 
"""

For a class, use :cvar variable: for class variable, :ivar variable: for instance class
variable, .. attribute:: attribute: for attributes, .... 
See http://sphinx.pocoo.org/markup/desc.html and http://sphinx.pocoo.org/markup/inline.html

Tips and Tricks
===============
Change in many files something:

perl -pi -w -e "s/L{PersonRef}/:class:\`\~gen.lib.personref.PersonRef\`/g;" *.py 

here L{PersonRef} is changed in :class:`~gen.lib.personref.PersonRef
`