15,534
edits
Changes
Devhelp
,no edit summary
How to include [httphttps://live.gnomegramps-project.org/devhelp Devhelp] is a Gtk+docs/Gnome browser for Gramps API documentation; it works natively with [http://www.gtk.org/gtk-doc/ gtk-doc] (which is into the API reference format for Gtk+/Gnome documentation)Devhelp index.
==Paths==
According to [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working patchs should paths could be: * devhelp ''~/.local/share/devhelp/books/gramps/gramps.devhelp'' ''/usr/local/share/devhelp/books/gramps/gramps.devhelp''
==Steps==
1. Go to ''Gramps_SVNGramps/docs'' folder
2. modifiy modify 'update_doc.py' for generating a devhelp file via 'devhelp' key for builder:
$ sphinx-build -b devhelp . _build/devhelp
3. run 'update_doc.py':
$ PYTHONPATH=/usr/local/lib/python2.7/site-packages/:/home/jerome/trunk python cd docs $ python3 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 [[#Paths|above paths for : ~/.local/share/devhelp index]]./books
==See also==
* [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build]
* [https://gramps-project.org/docs/ Gramps API]
* [https://github.com/gramps-project/gramps/tree/master/docs Instructions to build the Gramps API Doc's]
[[Category:Developers/General]]
[[Category:Developers/Tutorials]]
[[Category:GEPS]]