|
|
20.
|
|
|
Devhelp is a developer tool for browsing and searching API documentation.
|
|
|
(itstool) path: synopsis/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/index.page:11
|
|
|
21.
|
|
|
Installing API documentation
|
|
|
(itstool) path: page/title
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:14
|
|
|
22.
|
|
|
How <app>Devhelp</app> finds the API documentation.
|
|
|
(itstool) path: synopsis/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:17
|
|
|
23.
|
|
|
See <link xref="book-format"/> for information on the API documentation format that <app>Devhelp</app> recognizes.
|
|
|
(itstool) path: section/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:24
|
|
|
24.
|
|
|
Books locations
|
|
|
(itstool) path: section/title
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:31
|
|
|
25.
|
|
|
Once a book follows the right format, its directory needs to be installed at a location where <app>Devhelp</app> will find it.
|
|
|
(itstool) path: section/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:32
|
|
|
26.
|
|
|
<app>Devhelp</app> uses the <link href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</link> to find the books. The list of locations searched is:
|
|
|
(itstool) path: section/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:36
|
|
|
27.
|
|
|
Note that the two latter consist of :-separated lists of directories to look for. Those environment variables are normally set up by the desktop environment or distribution.
|
|
|
(itstool) path: section/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:47
|
|
|
28.
|
|
|
Examples of locations to index files with <code>$XDG_DATA_HOME</code> on a typical system:
|
|
|
(itstool) path: section/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:52
|
|
|
29.
|
|
|
<file>~/.var/app/org.gnome.Devhelp/data/devhelp/books/glib/glib.devhelp2</file> if <app>Devhelp</app> is launched with <link href="https://flatpak.org/">Flatpak</link>.
|
|
|
(itstool) path: item/p
|
|
|
|
|
(no translation yet)
|
|
|
|
Located in
C/installing-api-documentation.page:60
|
