Difference between revisions of "Devhelp"

From Gramps
Jump to: navigation, search
m (Steps)
(add a category)
(8 intermediate revisions by one other user not shown)
Line 25: Line 25:
 
==Steps==
 
==Steps==
  
1. Go to ''Gramps_SVN/docs'' folder (trunk: gen modules are OK, broken relative import for specific modules and interfaces related to Gramps)
+
1. Go to ''Gramps_SVN/docs'' folder
  
2. modifiy 'makefile' for generating a devhelp file via 'devhelp' key for builder:
+
2. modifiy 'update_doc.py' for generating a devhelp file via 'devhelp' key for builder:
  
  $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
+
  $ sphinx-build -b devhelp _build/devhelp
  
3. copy the content of ''_build/devhelp'' directory into one of the [[#Paths|above paths for devhelp index]].
+
could be:
  
4. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package)
+
$ 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 [[#Paths|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==
 
==See also==
Line 41: Line 54:
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Developers/Tutorials]]
 
[[Category:Developers/Tutorials]]
 +
[[Category:GEPS]]

Revision as of 01:40, 15 February 2014

Gramps-notes.png

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


Steps for including 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 patchs should be:

  • devhelp

~/.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

1. Go to Gramps_SVN/docs folder

2. modifiy '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