Default page

Your IP: 216.73.216.91
Server IP: 157.245.101.34
Server: Linux skvinfotech-website 5.4.0-131-generic #147-Ubuntu SMP Fri Oct 14 17:07:22 UTC 2022 x86_64
Server Software: Apache/2.4.41 (Ubuntu)
PHP Version: 7.4.33
Buat File | Buat Folder

Edit File: installing-api-documentation.page

<?xml version="1.0" encoding="utf-8"?>

<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" id="installing-api-documentation" xml:lang="cs">

<title>Instalace dokumentace k API</title>

<synopsis>
 Jak <app>Devhelp</app> hledá v dokumentaci API.
</synopsis>

<section id="book-format">
 <title>Formát knihy</title>
 Viz <link xref="book-format"/> ohledně informací o formátu dokumentace k API, který <app>Devhelp</app> rozpoznává.
</section>

<section id="books-locations">
 <title>Umístění knih</title>
 Jakmile má kniha správný formát, musí být její složka nainstalována do umístění, ve kterém ji <app>Devhelp</app> najde.
 
 <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:
 
 <list its:translate="no">
 <item><code>$XDG_DATA_HOME/devhelp/books/</code></item>
 <item><code>$XDG_DATA_HOME/gtk-doc/html/</code></item>
 <item><code>$XDG_DATA_DIRS/devhelp/books/</code></item>
 <item><code>$XDG_DATA_DIRS/gtk-doc/html/</code></item>
 </list>
 Všimněte si, že dvě poslední jsou ve skutečnosti seznamy složek oddělených dvojtečkou, ve kterých se hledá. Tyto proměnné prostředí normálně nastaví pracovní prostředí nebo distribuce.
 Příklad umístění pro indexové soubory s <code>$XDG_DATA_HOME</code> na typickém systému:
 <list>
 <item its:translate="no">
 <file>~/.local/share/devhelp/books/glib/glib.devhelp2</file>
 </item>
 <item>Soubor <file>~/.var/app/org.gnome.Devhelp/data/devhelp/books/glib/glib.devhelp2</file>, pokud je <app>Devhelp</app> spuštěný v izolovaném prostředí <link href="https://flatpak.org/">Flatpak</link>.</item>
 </list>
 Příklad umístění pro indexové soubory s <code>$XDG_DATA_HOME</code> na typickém systému:
 <list>
 <item its:translate="no">
 <file>/usr/share/gtk-doc/html/glib/glib.devhelp2</file>
 </item>
 </list>
</section>

<section id="gtk-doc">
 <title>GTK-Doc</title>
 <link href="https://www.gtk.org/gtk-doc/">GTK-Doc</link> je nástroj pro generování dokumentace k API z komentářů ve zdrojových kódech jazyka C. Používají jej GLib, GTK a knihovny a aplikace GNOME
 GTK-Doc instaluje referenční příručku k API modulu do:
 
 <code>$datadir/gtk-doc/html/$module_name/</code>
 
 Řídí se formátem knihy, který podporuje <app>Devhelp</app>. Takže, když použijete GTK-Doc, lze pak automaticky referenční příručku k API procházet pomocí aplikace <app>Devhelp</app> (za předpokladu, že je nainstalována ve správném umístění).
</section>
</page>