Difference between revisions of "Devhelp"
m (→Steps) |
m (→Steps) |
||
Line 41: | Line 41: | ||
4. copy the content of ''_build/devhelp'' directory into one of the [[#Paths|above paths for devhelp index]]. | 4. copy the content of ''_build/devhelp'' directory into one of the [[#Paths|above paths for devhelp index]]. | ||
− | Need to use the '''same name''' for the devhelp and the top directory (e.g., Gramps) | + | Need to use the '''same name''' for the devhelp file and the top directory (e.g., Gramps) |
==Updated APIs== | ==Updated APIs== |
Revision as of 12:31, 28 January 2017
This article's content is incomplete or a placeholder stub. |
Steps for including the Gramps API into devhelp index.
Contents
Devhelp
Devhelp is a Gtk+/Gnome browser for API documentation; it works natively with gtk-doc (which is the API reference format for Gtk+/Gnome documentation).
Paths
According to base directories from freedesktop, the working paths could be:
$XDG_DATA_DIRS/devhelp/books $XDG_DATA_DIRS/gtk-doc/html
Steps
1. Go to Gramps/docs folder
2. modify 'update_doc.py' for generating a devhelp file via 'devhelp' key for builder:
$ sphinx-build -b devhelp . _build/devhelp
could be:
$ os.system(' ' '%(program)s -b devhelp . _build/devhelp' ' ' % {'program': sphinxCmd})
in python.
3. run 'update_doc.py':
eg,
$ cd docs $ python3 update_doc.py
4. copy the content of _build/devhelp directory into one of the above paths for devhelp index.
Need to use the same name for the devhelp file and the top directory (e.g., Gramps)
Updated 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