Difference between revisions of "Devhelp"
m (→Paths) |
m (→Steps) |
||
| Line 25: | Line 25: | ||
==Steps== | ==Steps== | ||
| − | 1. Go to '' | + | 1. Go to ''Gramps/docs'' folder |
2. modify 'update_doc.py' for generating a devhelp file via 'devhelp' key for builder: | 2. modify 'update_doc.py' for generating a devhelp file via 'devhelp' key for builder: | ||
Revision as of 08:38, 28 January 2017
|
This article's content is incomplete or a placeholder stub. |
Steps for including the Gramps API into devhelp index.
Contents
Devhelp
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).
Paths
According base directories from freedesktop, the working paths should be:
- devhelp
~/.local/share/devhelp/books/gramps/gramps.devhelp
/usr/local/share/devhelp/books/gramps/gramps.devhelp
- gtk-doc
/usr/share/gtk-doc/html/gramps/gramps.devhelp
Steps
1. Go to Gramps/docs folder
2. modify 'update_doc.py' 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 'update_doc.py':
eg,
$ PYTHONPATH=/usr/local/lib/python2.7/site-packages/:/home/jerome/trunk python update_doc.py
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)
