5,421
edits
Changes
m
{{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).
==Paths== $XDG_DATA_DIRS/devhelp/books $XDG_DATA_DIRS/gtk-doc/html
According [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working patchs should be:==Steps==
* devhelp1. Go to ''Gramps/docs'' folder
''/usr/local/share/ $ sphinx-build -b devhelp. _build/books/gramps/gramps.devhelp''
* gtk-doccould be:
==Steps==in python.
13. Go to ''Gramps_SVN/docsrun 'update_doc.py' folder:
2e. modifiy 'update_docg.py' for generating a devhelp file via 'devhelp' key for builder:,
could be4. copy the content of ''_build/devhelp'' directory into: ~/.local/share/devhelp/books
$ os.system(''Need to use the '%(program)s -b devhelp . _build/devhelp''same name' % {'program': sphinxCmd}for the devhelp file and the top directory (e.g., Gramps)
in ==Updated python.APIs==
3. run 'update_doc.py'Give a try to:
eg, git clone https://github.com/lazka/pgi-docs-devhelp.git ~/.local/share/devhelp/books devhelp
$ PYTHONPATH=/usr/local/lib/python2.7/site-packages/To update:/home/jerome/trunk python update_doc.py # path for ppygobject 3.3.2: path to gramps dir
4 cd ~/. copy the content of ''_buildlocal/share/devhelp'' directory into one of the [[#Paths|above paths for devhelp index]]./books git pull
5. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package){{-}}
→See also: adding sphinx snippets
How to include [[Filehttps:devhelp//gramps-project.png|600px|thumb|center|org/docs/ Gramps and Gtk3 APIs API] into devhelp browser]]the Devhelp index.
==DevhelpPaths==
According to [http://livestandards.gnomefreedesktop.org/devhelp Devhelp] is a Gtk+/Gnome browser for API documentation; it works natively with [http://www.gtk.orgbasedir-spec/gtk-doclatest/ gtk-docbase directories from freedesktop] (which is , the API reference format for Gtk+/Gnome documentation).working paths could be:
2. modify 'update_doc.py'~/.local/share/for generating a devhelp/books/gramps/gramps.file via 'devhelp''key for builder:
$ os.system(' ''/usr/share/gtk%(program)s -docb devhelp . _build/html/gramps/gramps.devhelp''' % {'program': sphinxCmd})
$ sphinx-build -b devhelp cd docs $ python3 update_doc. _build/devhelppy
==See also==
* [https://gramps-project.org/docs/ Gramps API] in Sphinx* [https://github.com/gramps-project/gramps/tree/master/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]]