Difference between revisions of "Devhelp"

From Gramps
Jump to: navigation, search
(Created page with "{{stub}} Steps for including Gramps' API into devhelp index. ==Devhelp== [http://live.gnome.org/devhelp Devhelp] is a Gtk+/Gnome browser for API documentation; it works nat...")
 
(45 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub}}
+
[[File:Devhelp-gramps-api-5.png|800px|right|Gramps and Gtk3 APIs into devhelp browser]]
  
Steps for including Gramps' API into devhelp index.
+
[http://live.gnome.org/devhelp Devhelp] is a Gtk+/Gnome browser for API documentation; it works natively with [http://www.gtk.org/gtk-doc/ gtk-doc] (which is the API reference format for Gtk+/Gnome documentation).
 +
 
 +
How to include [https://gramps-project.org/docs/ Gramps API] into the Devhelp index.
 +
 
 +
==Paths==
  
==Devhelp==
+
According to [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working paths could be:
  
[http://live.gnome.org/devhelp Devhelp] is a Gtk+/Gnome browser for API documentation; it works natively with [http://www.gtk.org/gtk-doc/ gtk-doc] (which is the API reference format for Gtk+/Gnome documentation).
+
$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':
 +
 
 +
e.g.,
 +
 
 +
$ cd docs
 +
$ python3 update_doc.py
 +
 
 +
4. copy the content of ''_build/devhelp'' directory into:
 +
~/.local/share/devhelp/books
 +
 
 +
Need to use the '''same name''' for the devhelp file and the top directory (e.g., Gramps)
 +
 
 +
==Updated python APIs==
 +
 
 +
Give a try to:
 +
 
 +
    git clone https://github.com/lazka/pgi-docs-devhelp.git ~/.local/share/devhelp/books
 +
    devhelp
  
==Paths==
+
To update:
  
According [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working patch should be:
+
    cd ~/.local/share/devhelp/books
 +
    git pull
  
* devhelp
+
{{-}}
  
''~/.local/share/devhelp/books/gramps/gramps.devhelp''
+
==See also==
''/usr/local/share/devhelp/books/gramps/gramps.devhelp''
 
  
* gtk-doc
+
* [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build]
  
''/usr/share/gtk-doc/html/gramps''
+
* [https://gramps-project.org/docs/ Gramps API]
 +
* [https://github.com/gramps-project/gramps/tree/master/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 01:31, 29 January 2017

Gramps and Gtk3 APIs into devhelp browser

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

How to include Gramps API into the Devhelp index.

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':

e.g.,

$ cd docs
$ python3 update_doc.py 

4. copy the content of _build/devhelp directory into:

~/.local/share/devhelp/books

Need to use the same name for the devhelp file and the top directory (e.g., Gramps)

Updated python 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