Devhelp

This article's content is incomplete or a placeholder stub. Please update or expand this section.

Steps for including the Gramps API into devhelp index.

Gramps and Gtk3 APIs into devhelp browser

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.

5. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package)

Alternative

An alternative to sphinx builder could be this collection of files describing integration support of arbitrary html based (api/developer) documentation.

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

See also

• Sphinx-build

• Gramps API
• Instructions to build the Gramps API Doc's