source: general/genutils/gtk-doc.xml@ 422d284

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/&gtk-doc-major;/gtk-doc-&gtk-doc-version;.tar.xz">
  <!ENTITY gtk-doc-download-ftp  " ">
  <!ENTITY gtk-doc-md5sum        "f0e7385ba25eddb6ce0953e8cf63d1bf">
  <!ENTITY gtk-doc-size          "484 KB">
  <!ENTITY gtk-doc-buildsize     "14 MB (with tests)">
  <!ENTITY gtk-doc-time          "0.2 SBU (with tests)">
]>

<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-doc-version;">
  <?dbhtml filename="gtk-doc.html"?>


  <title>GTK-Doc-&gtk-doc-version;</title>

  <indexterm zone="gtk-doc">
    <primary sortas="a-GTK-Doc">GTK-Doc</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GTK-Doc</title>

    <para>
      The <application>GTK-Doc</application> package contains a code
      documenter. This is useful for extracting specially formatted comments
      from the code to create API documentation. This package is
      <emphasis>optional</emphasis>; if it is not installed, packages will
      not build the documentation. This does not mean that you will not have
      any documentation. If <application>GTK-Doc</application> is not
      available, the install process will copy any pre-built documentation
      to your system.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&gtk-doc-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&gtk-doc-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &gtk-doc-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &gtk-doc-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &gtk-doc-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &gtk-doc-time;
        </para>
      </listitem>
    </itemizedlist>
<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch to allow building <xref linkend="glib2"/>
          documentation:
          <ulink url="&patch-root;/gtk-doc-&gtk-doc-version;-glib2_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>,
      <xref linkend="glib2"/>,
      <xref linkend="itstool"/>, 
      <xref linkend="libxslt"/>, and
      <xref linkend="pygments"/>
    </para>
<!--
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref role="runtime" linkend="pygments"/> at run time
    </para>
-->
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      For tests:
      <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink> or
      <xref linkend="fop"/> (XML PDF support),
      <xref linkend="glib2"/>,
      <xref linkend="which"/>, and
      Python modules
      <xref linkend="lxml"/>,
      <!--<ulink url="https://anytree.readthedocs.io/en/latest/">anytree</ulink>,-->
      <ulink url="https://pypi.org/project/parameterized/">parameterized</ulink>,
      and <ulink url="&gnome-download-http;/yelp-tools">yelp-tools</ulink>
    </para>

    <note>
      <para>
      The optional python modules above can be easily installed with
      the <command>pip3</command> command.
      </para>
    </note>


  </sect2>

  <sect2 role="installation">
    <title>Installation of GTK-Doc</title>

    <para>
      Install <application>GTK-Doc</application> by running
      the following commands:
    </para>

<screen><userinput>mkdir -p build &amp;&amp;
cd       build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      The test suite will hang if the package (or a previous version)
      is not already installed.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
      Some tests will fail depending on optionally installed packages.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          gtkdocize,
          gtkdoc-check,
          gtkdoc-depscan,
          gtkdoc-fixxref,
          gtkdoc-mkdb,
          gtkdoc-mkhtml,
          gtkdoc-mkhtml2,
          gtkdoc-mkman,
          gtkdoc-mkpdf,
          gtkdoc-rebase,
          gtkdoc-scan, and
          gtkdoc-scangobj
        </seg>

        <seg>None</seg>

        <seg>
          /usr/share/gtk-doc and
          /usr/share/cmake/GtkDoc
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gtkdoc">
        <term><command>gtkdoc*</command></term>
        <listitem>
          <para>
            these are all shell, or
            <application>Python</application> scripts used by
            package <filename>Makefile</filename> scripts to generate
            documentation for the package being built
          </para>
          <indexterm zone="gtk-doc gtkdoc">
            <primary sortas="b-gtkdoc*">gtkdoc*</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>