Open main menu

Gramps β

Changes

Devhelp

161 bytes added, 17:40, 15 November 2024
m
See also: adding sphinx snippets
{{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 the API documentation; it works natively with [https://gramps-projectwiki.gnome.org/docsDocumentationProject/ Gramps GtkDoc gtk-doc] (which is the API] into devhelp indexreference format for Gtk+/Gnome documentation).
How to include [[Filehttps:Devhelp-//gramps-api-34.png|600px|thumb|right|Gramps and Gtk3 APIs into devhelp browser]] ==Devhelp== [http://live.gnomeproject.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 paths should could be: * devhelp ''~/.local/share/devhelp/books/gramps/gramps.devhelp'' ''/usr/local/share/devhelp/books/gramps/gramps.devhelp'' * gtk-doc
'' $XDG_DATA_DIRS/usrdevhelp/sharebooks $XDG_DATA_DIRS/gtk-doc/html/gramps/gramps.devhelp''
==Steps==
3. run 'update_doc.py':
ege.g.,   $ cd docs $ python3 update_doc.py  4. copy the content of ''_build/devhelp'' directory into: ~/.local/share/devhelp/books Need to use the '''same name''' for the devhelp file and the top directory (e.g., Gramps) ==Updated python APIs==
$ PYTHONPATH=/usr/local/lib/python2.7/site-packages/Give a try to:/home/jerome/trunk python update_doc.py path for pygobject 3.3.2 (trunk): path to gramps dir
4 git clone https://github. copy the content of ''_buildcom/lazka/pgi-docs-devhelp'' directory into one of the [[#Paths|above paths for .git ~/.local/share/devhelp/books devhelp index]].
5. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package)To update:
==See also== cd ~/.local/share/devhelp/books git pull
* [http://sphinx{{-doc.org/man/sphinx-build.html Sphinx-build]}}
==See also==* [https://gramps-project.org/docs/ Gramps API]in Sphinx* [httphttps://sourceforgegithub.netcom/pgramps-project/gramps/source/citree/master/tree/docs/ Instructions to build the Gramps API Doc's] in Sphinx using GitHub* [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build] on sphinx-doc.org* [https://gramps.discourse.group/t/how-can-useful-snippets-be-proposed-for-the-sphinx-developer-docs/5740 How can "Useful Snippets" be proposed for the Sphinx developer docs]
[[Category:Developers/General]]
[[Category:Developers/Tutorials]]
[[Category:GEPS]]
5,421
edits