<?xml version="1.0" encoding="utf-8"?>
<!--
SPDX-FileCopyrightText: 2019 Sébastien Wilmet <swilmet@gnome.org>
SPDX-License-Identifier: CC-BY-SA-4.0
-->
<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">

<info>
  <link type="guide" xref="index"/>
</info>

<title>Instalace dokumentace k API</title>

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

<links type="section"/>

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

<section id="books-locations">
  <title>Umístění knih</title>
  <p>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.</p>
  <p><app>Devhelp</app> používá k nalezení knih <link href="https://specifications.freedesktop.org/basedir-spec/latest/">Specifikaci základních složek XDG</link> (odkaz je v angličtině). Zde je seznam prohledávaných umístění:</p>
  <list its:translate="no">
    <item><p><code>$XDG_DATA_HOME/devhelp/books/</code></p></item>
    <item><p><code>$XDG_DATA_HOME/gtk-doc/html/</code></p></item>
    <item><p><code>$XDG_DATA_DIRS/devhelp/books/</code></p></item>
    <item><p><code>$XDG_DATA_DIRS/gtk-doc/html/</code></p></item>
  </list>
  <p>Všimněte si, že dvě poslední jsou ve skutečnosti seznamy složek, ve kterých se hledá. Názvy složek jsou oddělené znakem <code>:</code>. Tyto proměnné prostředí normálně nastaví pracovní prostředí nebo distribuce.</p>
  <p>Příklad umístění pro indexové soubory s <code>$XDG_DATA_HOME</code> na typickém systému:</p>
  <list>
    <item its:translate="no"><p>
      <file>~/.local/share/devhelp/books/glib/glib.devhelp2</file>
    </p></item>
    <item><p>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>.</p></item>
  </list>
  <p>Příklad umístění pro indexové soubory s <code>$XDG_DATA_HOME</code> na typickém systému:</p>
  <list>
    <item its:translate="no"><p>
      <file>/usr/share/gtk-doc/html/glib/glib.devhelp2</file>
    </p></item>
  </list>
</section>

<section id="gtk-doc">
  <title>GTK-Doc</title>
  <p><link href="https://gitlab.gnome.org/GNOME/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</p>
  <p>GTK-Doc instaluje referenční příručku k API modulu do:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Ří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í).</p>
</section>
</page>
