<?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="uk">

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

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Юрій Чорноіван</mal:name>
      <mal:email>yurchor@ukr.net</mal:email>
      <mal:years>2020</mal:years>
    </mal:credit>
  </info>

<title>Встановлення документації з програмного інтерфейсу</title>

<synopsis>
  <p>Як <app>Devhelp</app> знаходить документацію до програмного інтерфейсу.</p>
</synopsis>

<links type="section"/>

<section id="book-format">
  <title>Формат книги</title>
  <p>Див. <link xref="book-format"/>, щоб дізнатися більше про формат документації до програмного інтерфейсу, який розпізнається <app>Devhelp</app>.</p>
</section>

<section id="books-locations">
  <title>Розташування книг</title>
  <p>Якщо книгу записано у належному форматі, її каталог має бути встановлено у місці, де <app>Devhelp</app> його знайде.</p>
  <p><app>Devhelp</app> використовує <link href="https://specifications.freedesktop.org/basedir-spec/latest/">специфікацію базового каталогу XDG</link> для пошуку книг. Ось список місць, де відбуватиметься пошук:</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>Зауважте, що два останніх складаються зі списків каталогів для пошуку. Записи каталогів має бути відокремлено символами <code>:</code>. Ці змінні середовища, зазвичай, визначаються стільничним середовищем або дистрибутивом.</p>
  <p>Приклади місць файлів покажчика із <code>$XDG_DATA_HOME</code> у типовій системі:</p>
  <list>
    <item its:translate="no"><p>
      <file>~/.local/share/devhelp/books/glib/glib.devhelp2</file>
    </p></item>
    <item><p><file>~/.var/app/org.gnome.Devhelp/data/devhelp/books/glib/glib.devhelp2</file>, якщо <app>Devhelp</app> запущено з пакунка <link href="https://flatpak.org/">Flatpak</link>.</p></item>
  </list>
  <p>Приклад розташування файла покажчика із <code>$XDG_DATA_DIRS</code> у типовій системі:</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> — інструмент для створення документації до програмного інтерфейсу на основі коментарів у коді C. Він використовується GLib, GTK та бібліотеками і програмами GNOME.</p>
  <p>GTK-Doc встановлює довідник із програмного інтерфейсу модуля до такого каталогу:</p>
  <p its:translate="no">
    <code>$datadir/gtk-doc/html/$module_name/</code>
  </p>
  <p>Використовується формат книги, підтримку якого передбачено у <app>Devhelp</app>. Отже, використання GTK-Doc надає змогу автоматично переглядати довідник з програмного інтерфейсу у <app>Devhelp</app> (достатньо просто встановити дані до належного каталогу).</p>
</section>
</page>
