Difference between revisions of "Devhelp"

From Gramps
Jump to: navigation, search
m (Steps)
(Should I rename this article as it mentions "How to include [https://gramps-project.org/docs/ Gramps API] into the Devhelp index." ?)
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{stub}}
+
[[File:Devhelp-gramps-api-5.png|450px|right|thumb|Gramps and Gtk3 APIs into devhelp browser]]
  
Steps for including Gramps' API into devhelp index.
+
[https://wiki.gnome.org/Apps/Devhelp Devhelp] is a Gtk+/Gnome browser for API documentation; it works natively with [https://wiki.gnome.org/DocumentationProject/GtkDoc gtk-doc] (which is the API reference format for Gtk+/Gnome documentation).
  
[[File:devhelp.png|600px|thumb|center|Gramps and Gtk3 APIs into devhelp browser]]
+
How to include [https://gramps-project.org/docs/ Gramps API] into the Devhelp index.
  
==Devhelp==
+
==Paths==
 +
 
 +
According to [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working paths could be:
 +
 
 +
$XDG_DATA_DIRS/devhelp/books
 +
$XDG_DATA_DIRS/gtk-doc/html
 +
 
 +
==Steps==
  
[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).
+
1. Go to ''Gramps/docs'' folder
  
==Paths==
+
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})
  
According [http://standards.freedesktop.org/basedir-spec/latest/ base directories from freedesktop], the working patchs should be:
+
in python.
  
* devhelp
+
3. run 'update_doc.py':
  
''~/.local/share/devhelp/books/gramps/gramps.devhelp''
+
e.g.,
  
''/usr/local/share/devhelp/books/gramps/gramps.devhelp''
+
$ cd docs
 +
$ python3 update_doc.py
  
* gtk-doc
+
4. copy the content of ''_build/devhelp'' directory into:
 +
~/.local/share/devhelp/books
  
''/usr/share/gtk-doc/html/gramps/gramps.devhelp''
+
Need to use the '''same name''' for the devhelp file and the top directory (e.g., Gramps)
  
==Steps==
+
==Updated python APIs==
  
1. Go to ''Gramps_SVN/docs'' folder (trunk: gen modules are OK, broken relative import for specific modules and interfaces related to Gramps)
+
Give a try to:
  
2. modifiy 'makefile' for generating a devhelp file via 'devhelp' key for builder:
+
    git clone https://github.com/lazka/pgi-docs-devhelp.git ~/.local/share/devhelp/books
 +
    devhelp
  
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
+
To update:
  
3. copy the content of ''_build/devhelp'' directory into one of the [[#Paths|above paths for devhelp index]].
+
    cd ~/.local/share/devhelp/books
 +
    git pull
  
4. 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]
 +
* [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]]
 +
[[Category:How do I...|D]]

Revision as of 22:59, 19 July 2021

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