Difference between revisions of "Devhelp"

From Gramps
Jump to: navigation, search
m (Steps)
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub}}
+
{{out of date}}
  
Steps for including Gramps' API into devhelp index.
+
Steps for including the [https://gramps-project.org/docs/ Gramps API] into devhelp index.
  
[[File:devhelp.png|600px|thumb|center|Gramps and Gtk3 APIs into devhelp browser]]
+
[[File:Devhelp-gramps-api-34.png|600px|thumb|right|Gramps and Gtk3 APIs into devhelp browser]]
  
 
==Devhelp==
 
==Devhelp==
Line 11: Line 11:
 
==Paths==
 
==Paths==
  
According [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working patchs should be:
+
According [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working patches should be:
  
 
* devhelp
 
* devhelp
Line 27: Line 27:
 
1. Go to ''Gramps_SVN/docs'' folder
 
1. Go to ''Gramps_SVN/docs'' folder
  
trunk: gramps.gen modules are OK, broken relative import for specific modules and interfaces related to Gramps program.
+
2. modify 'update_doc.py' for generating a devhelp file via 'devhelp' key for builder:
  
2. modifiy 'makefile' for generating a devhelp file via 'devhelp' key for builder:
+
$ sphinx-build -b devhelp . _build/devhelp
  
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
+
could be:
  
3. copy the content of ''_build/devhelp'' directory into one of the [[#Paths|above paths for devhelp index]].
+
$ os.system(' ' '%(program)s -b devhelp . _build/devhelp' ' ' % {'program': sphinxCmd})
  
4. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package)
+
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==
  
 
* [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build]
 
* [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build]
 +
 +
* [https://gramps-project.org/docs/ Gramps API]
 +
* [http://sourceforge.net/p/gramps/source/ci/master/tree/docs/ Instructions to build the Gramps API Doc's]
  
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Developers/Tutorials]]
 
[[Category:Developers/Tutorials]]
 +
[[Category:GEPS]]

Revision as of 23:21, 29 August 2015

Gramps-notes.png This page's factual accuracy may be compromised due to out-of-date information. Please help improve the Gramps Wiki as a useful resource by updating it.

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 patches 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. 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