Open main menu

Gramps β

Changes

Devhelp

192 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==
3. run 'update_doc.py':
ege.g.,
$ cd docs
$ python3 update_doc.py
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:
cd ~/.local/share/devhelp/books
git pull
 
{{-}}
==See also==
 * [httphttps://sphinxgramps-docproject.org/mandocs/sphinx-build.html Gramps API] in Sphinx-build] * [https://github.com/gramps-project.org/gramps/tree/master/docs/ Instructions to build the Gramps APIDoc's]in Sphinx using GitHub* [http://sourceforgesphinx-doc.netorg/pman/grampssphinx-build.html Sphinx-build] on sphinx-doc.org* [https:/source/cigramps.discourse.group/master/treet/how-can-useful-snippets-be-proposed-for-the-sphinx-developer-docs/ Instructions to build 5740 How can "Useful Snippets" be proposed for the Gramps API Doc'sSphinx developer docs]
[[Category:Developers/General]]
[[Category:Developers/Tutorials]]
[[Category:GEPS]]
5,421
edits