Changes

Jump to: navigation, search

Devhelp

164 bytes added, 22:59, 19 July 2021
Should I rename this article as it mentions "How to include [https://gramps-project.org/docs/ Gramps API] into the Devhelp index." ?
{{stub}}[[File:Devhelp-gramps-api-5.png|450px|right|thumb|Gramps and Gtk3 APIs into devhelp browser]]
Steps [https://wiki.gnome.org/Apps/Devhelp Devhelp] is a Gtk+/Gnome browser for including Gramps' API into devhelp indexdocumentation; it works natively with [https://wiki.gnome.org/DocumentationProject/GtkDoc gtk-doc] (which is the API reference format for Gtk+/Gnome documentation).
How to include [[File:devhelp.png|600px|thumb|center|Gramps and Gtk3 APIs into devhelp browser]] ==Devhelp== [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 $XDG_DATA_DIRS/devhelp/books/gramps/gramps.devhelp'' * gtk-doc ''/usr/share $XDG_DATA_DIRS/gtk-doc/html/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':
ege.g.,
$ 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
5. run a command (which one?) or wait Need to use the '''same name''' for the next post installation devhelp file and the top directory (rebuild of indexes after new packagee.g., Gramps) ==Updated python APIs== Give a try to:  git clone https://github.com/lazka/pgi-docs-devhelp.git ~/.local/share/devhelp/books devhelp To update:  cd ~/.local/share/devhelp/books git pull {{-}}
==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]]
[[Category:How do I...|D]]
CallMeDave
1,969
edits
Retrieved from "https://www.gramps-project.org/wiki/index.php/Special:MobileDiff/48378...86328"

Navigation menu