Difference between revisions of "Devhelp"
From Gramps
m (→Steps) |
m (→See also: adding sphinx snippets) |
||
| (45 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[File:Devhelp-gramps-api-5.png|450px|right|thumb|Gramps and Gtk3 APIs into devhelp browser]] | |
| − | + | [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). | |
| − | [ | + | How to include [https://gramps-project.org/docs/ Gramps API] into the Devhelp index. |
| − | == | + | ==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== | ||
| + | |||
| + | 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== | ==See also== | ||
| − | + | * [https://gramps-project.org/docs/ Gramps API] in Sphinx | |
| − | * [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build] | + | * [https://github.com/gramps-project/gramps/tree/master/docs Instructions to build the Gramps API Doc's] in Sphinx using GitHub |
| + | * [http://sphinx-doc.org/man/sphinx-build.html Sphinx-build] on sphinx-doc.org | ||
| + | * [https://gramps.discourse.group/t/how-can-useful-snippets-be-proposed-for-the-sphinx-developer-docs/5740 How can "Useful Snippets" be proposed for the Sphinx developer docs] | ||
[[Category:Developers/General]] | [[Category:Developers/General]] | ||
[[Category:Developers/Tutorials]] | [[Category:Developers/Tutorials]] | ||
| + | [[Category:GEPS]] | ||
Latest revision as of 17:40, 15 November 2024
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.
Contents
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
- Gramps API in Sphinx
- Instructions to build the Gramps API Doc's in Sphinx using GitHub
- Sphinx-build on sphinx-doc.org
- How can "Useful Snippets" be proposed for the Sphinx developer docs
