Difference between revisions of "Devhelp"

From Gramps
Jump to: navigation, search
m (Steps)
m (Paths)
Line 11: Line 11:
 
==Paths==
 
==Paths==
  
According [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working paths should be:
+
According [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working paths could be:
  
* devhelp
+
$XDG_DATA_DIRS/devhelp/books
 
 
''~/.local/share/devhelp/books/gramps/gramps.devhelp''
 
 
 
''/usr/local/share/devhelp/books/gramps/gramps.devhelp''
 
 
 
* gtk-doc
 
 
 
''/usr/share/gtk-doc/html/gramps/gramps.devhelp''
 
  
 
==Steps==
 
==Steps==

Revision as of 09:55, 28 January 2017

Gramps-notes.png

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 base directories from freedesktop, the working paths could be:

$XDG_DATA_DIRS/devhelp/books

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,

$ PYTHONPATH=/usr/local/lib/python2.7/site-packages/:/home/jerome/trunk python update_doc.py 

path for pygobject 3.3.2 (trunk): path to gramps dir

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)

See also