Położenia książek
Kiedy książka używa już właściwego formatu, jej katalog musi zostać zainstalowany w położeniu, w którym Devhelp ją znajdzie.
Devhelp używa Specyfikacji podstawowych katalogów XDG do wyszukiwania książek. Lista przeszukiwanych położeń:
$XDG_DATA_HOME/devhelp/books/
$XDG_DATA_HOME/gtk-doc/html/
$XDG_DATA_DIRS/devhelp/books/
$XDG_DATA_DIRS/gtk-doc/html/
Zauważ, że dwa ostatnie składają się z list katalogów do wyszukiwania rozdzielonych „:”. Te zmienne środowiskowe są zwykle konfigurowane przez środowisko pulpitu lub dystrybucję.
Przykłady położeń plików indeksów ze zmienną $XDG_DATA_HOME w typowym systemie:
~/.local/share/devhelp/books/glib/glib.devhelp2
~/.var/app/org.gnome.Devhelp/data/devhelp/books/glib/glib.devhelp2, jeśli Devhelp został uruchomiony za pomocą pakietu Flatpak.
Przykład położenia pliku indeksu ze zmienną $XDG_DATA_HOME w typowym systemie:
/usr/share/gtk-doc/html/glib/glib.devhelp2
GTK-Doc
GTK-Doc to narzędzie do tworzenia dokumentacji API z komentarzy dodanych do kodu w języki C. Jest używane przez biblioteki GLib, GTK i programy GNOME.
GTK-Doc instaluje referencje API modułu do:
$datadir/gtk-doc/html/$module_name/
Używa formatu książki obsługiwanego przez Devhelp. W ten sposób używając GTK-Doc można automatycznie przeglądać referencje API w programie Devhelp (po zainstalowaniu ich w odpowiednim położeniu).