Difference between revisions of "Devhelp"
(→Paths) |
m (→Steps) |
||
| Line 34: | Line 34: | ||
4. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package) | 4. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package) | ||
| + | |||
| + | ==See also== | ||
| + | |||
| + | * [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build] | ||
[[Category:Developers/General]] | [[Category:Developers/General]] | ||
[[Category:Developers/Tutorials]] | [[Category:Developers/Tutorials]] | ||
Revision as of 08:53, 30 November 2012
|
This article's content is incomplete or a placeholder stub. |
Steps for including 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 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 (only 3.4 branch is up-to-date)
2. modifiy 'makefile' for generating a devhelp file via 'devhelp' key for builder:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
3. copy the content of _build/devhelp directory into one of the above paths for devhelp index.
4. run a command (which one?) or wait for the next post installation (rebuild of indexes after new package)
