From Gramps
Revision as of 02:03, 4 December 2012 by Romjerome (Talk | contribs) (Steps)

Jump to: navigation, search
This may be an outdated section. Please help keep Gramps Wiki a useful resource by updating and expanding this section.

Steps for including Gramps' API into devhelp index.

Gramps and Gtk3 APIs into devhelp browser


Devhelp is a Gtk+/Gnome browser for API documentation; it works natively with gtk-doc (which is the API reference format for Gtk+/Gnome documentation).


According base directories from freedesktop, the working patchs should be:

  • devhelp



  • gtk-doc



1. Go to Gramps_SVN/docs folder

2. modifiy '' for generating a devhelp file via 'devhelp' key for builder:

$ sphinx-build -b devhelp .  _build/devhelp

could be:

$ os.system(' ' '%(program)s -b devhelp . _build/devhelp' ' ' % {'program': sphinxCmd})

in python.

3. run '':


$ PYTHONPATH=/usr/local/lib/python2.7/site-packages/:/home/jerome/trunk python 

path for pygobject 3.3.2 (trunk): path to gramps dir

4. copy the content of _build/devhelp directory into one of the above paths for devhelp index.

5. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package)

See also