[fdca4266] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[fdca4266] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8d45c9a] | 7 | <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/>k-doc-major;/gtk-doc->k-doc-version;.tar.xz">
|
---|
| 8 | <!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/>k-doc-major;/gtk-doc->k-doc-version;.tar.xz">
|
---|
[c3447c89] | 9 | <!ENTITY gtk-doc-md5sum "ea6563421abe964d02135ca0d5b8dd8e">
|
---|
| 10 | <!ENTITY gtk-doc-size "496 KB">
|
---|
| 11 | <!ENTITY gtk-doc-buildsize "13 MB (with tests)">
|
---|
[c1add1f5] | 12 | <!ENTITY gtk-doc-time "0.2 SBU (with tests)">
|
---|
[fdca4266] | 13 | ]>
|
---|
| 14 |
|
---|
[a294e133] | 15 | <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
---|
[effdc6af] | 16 | <?dbhtml filename="gtk-doc.html"?>
|
---|
[fc7afd0c] | 17 |
|
---|
[effdc6af] | 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
[fc7afd0c] | 21 |
|
---|
[effdc6af] | 22 | <title>GTK-Doc->k-doc-version;</title>
|
---|
[fc7afd0c] | 23 |
|
---|
[effdc6af] | 24 | <indexterm zone="gtk-doc">
|
---|
| 25 | <primary sortas="a-GTK-Doc">GTK-Doc</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to GTK-Doc</title>
|
---|
[fc7afd0c] | 30 |
|
---|
[b7a85cd9] | 31 | <para>
|
---|
| 32 | The <application>GTK-Doc</application> package contains a code
|
---|
| 33 | documenter. This is useful for extracting specially formatted comments
|
---|
| 34 | from the code to create API documentation. This package is
|
---|
| 35 | <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
| 36 | not build the documentation. This does not mean that you will not have
|
---|
| 37 | any documentation. If <application>GTK-Doc</application> is not
|
---|
| 38 | available, the install process will copy any pre-built documentation
|
---|
| 39 | to your system.
|
---|
| 40 | </para>
|
---|
[fc7afd0c] | 41 |
|
---|
[88fdf09] | 42 | &lfs110a_checked;
|
---|
[a10f4a7] | 43 |
|
---|
[effdc6af] | 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
[b7a85cd9] | 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url=">k-doc-download-http;"/>
|
---|
| 49 | </para>
|
---|
[effdc6af] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[b7a85cd9] | 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url=">k-doc-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
[effdc6af] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[b7a85cd9] | 57 | <para>
|
---|
| 58 | Download MD5 sum: >k-doc-md5sum;
|
---|
| 59 | </para>
|
---|
[effdc6af] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[b7a85cd9] | 62 | <para>
|
---|
| 63 | Download size: >k-doc-size;
|
---|
| 64 | </para>
|
---|
[effdc6af] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[b7a85cd9] | 67 | <para>
|
---|
| 68 | Estimated disk space required: >k-doc-buildsize;
|
---|
| 69 | </para>
|
---|
[effdc6af] | 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
[b7a85cd9] | 72 | <para>
|
---|
| 73 | Estimated build time: >k-doc-time;
|
---|
| 74 | </para>
|
---|
[effdc6af] | 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
[7199a09] | 77 | <!--
|
---|
[ddd5a70] | 78 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 79 | <itemizedlist spacing="compact">
|
---|
| 80 | <listitem>
|
---|
| 81 | <para>
|
---|
| 82 | Required patch to allow building <xref linkend="glib2"/>
|
---|
| 83 | documentation:
|
---|
| 84 | <ulink url="&patch-root;/gtk-doc->k-doc-version;-glib2_fixes-1.patch"/>
|
---|
| 85 | </para>
|
---|
| 86 | </listitem>
|
---|
| 87 | </itemizedlist>
|
---|
[7199a09] | 88 | -->
|
---|
[effdc6af] | 89 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
[fc7afd0c] | 90 |
|
---|
[effdc6af] | 91 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[ba056d7] | 92 | <para role="required">
|
---|
| 93 | <xref linkend="DocBook"/>,
|
---|
| 94 | <xref linkend="docbook-xsl"/>,
|
---|
[0367db7] | 95 | <xref linkend="itstool"/>, and
|
---|
| 96 | <xref linkend="libxslt"/>
|
---|
[ba056d7] | 97 | </para>
|
---|
[64c6acb] | 98 |
|
---|
[9d10790] | 99 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 100 | <para role="recommended">
|
---|
| 101 | <xref role="runtime" linkend="pygments"/> at run time
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
[effdc6af] | 104 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b495000] | 105 | <para role="optional">
|
---|
[8558044] | 106 | For tests:
|
---|
[c6b192c] | 107 | <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink> or
|
---|
[665ac79f] | 108 | <xref linkend="fop"/> (XML PDF support),
|
---|
[b7279d4] | 109 | <xref linkend="glib2"/>,
|
---|
| 110 | <xref linkend="which"/>, and
|
---|
[8558044] | 111 | Python modules
|
---|
[ad112fd5] | 112 | <xref linkend="lxml"/>,
|
---|
[c3447c89] | 113 | <!--<ulink url="https://anytree.readthedocs.io/en/latest/">anytree</ulink>,-->
|
---|
[f455d4a] | 114 | <ulink url="https://pypi.org/project/parameterized/">parameterized</ulink>,
|
---|
| 115 | and <ulink url="&gnome-download-http;/yelp-tools">yelp-tools</ulink>
|
---|
[665ac79f] | 116 | </para>
|
---|
[fc7afd0c] | 117 |
|
---|
[b7a85cd9] | 118 | <note>
|
---|
| 119 | <para>
|
---|
| 120 | The optional python modules above can be easily installed with
|
---|
| 121 | the <command>pip3</command> command.
|
---|
| 122 | </para>
|
---|
| 123 | </note>
|
---|
[b7279d4] | 124 |
|
---|
[1039de3] | 125 | <para condition="html" role="usernotes">User Notes:
|
---|
| 126 | <ulink url="&blfs-wiki;/gtk-doc"/></para>
|
---|
| 127 |
|
---|
[effdc6af] | 128 | </sect2>
|
---|
[fc7afd0c] | 129 |
|
---|
[effdc6af] | 130 | <sect2 role="installation">
|
---|
| 131 | <title>Installation of GTK-Doc</title>
|
---|
| 132 |
|
---|
[b7a85cd9] | 133 | <para>
|
---|
| 134 | Install <application>GTK-Doc</application> by running
|
---|
| 135 | the following commands:
|
---|
| 136 | </para>
|
---|
[effdc6af] | 137 |
|
---|
[7199a09] | 138 | <screen><userinput>autoreconf -fiv &&
|
---|
| 139 | ./configure --prefix=/usr &&
|
---|
[2e46c65] | 140 | make</userinput></screen>
|
---|
| 141 |
|
---|
[b7a85cd9] | 142 | <para>
|
---|
[8558044] | 143 | The test suite will hang if the package (or a previous version)
|
---|
[b7a85cd9] | 144 | is not already installed.
|
---|
| 145 | </para>
|
---|
[0e5a229a] | 146 |
|
---|
[b7a85cd9] | 147 | <para>
|
---|
| 148 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 149 | </para>
|
---|
[fc7afd0c] | 150 |
|
---|
[effdc6af] | 151 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[fc7afd0c] | 152 |
|
---|
[b7a85cd9] | 153 | <para>
|
---|
[8558044] | 154 | To test the results, issue: <command>make check</command>.
|
---|
[b7a85cd9] | 155 | Some tests will fail depending on optionally installed packages.
|
---|
[8558044] | 156 | </para>
|
---|
[ad112fd5] | 157 |
|
---|
[effdc6af] | 158 | </sect2>
|
---|
[fc7afd0c] | 159 |
|
---|
[effdc6af] | 160 | <sect2 role="content">
|
---|
| 161 | <title>Contents</title>
|
---|
| 162 |
|
---|
| 163 | <segmentedlist>
|
---|
| 164 | <segtitle>Installed Programs</segtitle>
|
---|
| 165 | <segtitle>Installed Libraries</segtitle>
|
---|
| 166 | <segtitle>Installed Directories</segtitle>
|
---|
[fc7afd0c] | 167 |
|
---|
[effdc6af] | 168 | <seglistitem>
|
---|
[b7279d4] | 169 | <seg>
|
---|
| 170 | gtkdocize,
|
---|
[8558044] | 171 | gtkdoc-check,
|
---|
| 172 | gtkdoc-depscan,
|
---|
[b7279d4] | 173 | gtkdoc-fixxref,
|
---|
[8558044] | 174 | gtkdoc-mkdb,
|
---|
| 175 | gtkdoc-mkhtml,
|
---|
| 176 | gtkdoc-mkhtml2,
|
---|
| 177 | gtkdoc-mkman,
|
---|
[b7279d4] | 178 | gtkdoc-mkpdf,
|
---|
[8558044] | 179 | gtkdoc-rebase,
|
---|
| 180 | gtkdoc-scan, and
|
---|
[b7279d4] | 181 | gtkdoc-scangobj
|
---|
| 182 | </seg>
|
---|
[8558044] | 183 |
|
---|
[effdc6af] | 184 | <seg>None</seg>
|
---|
[8558044] | 185 |
|
---|
[b7279d4] | 186 | <seg>
|
---|
| 187 | /usr/share/gtk-doc and
|
---|
[7199a09] | 188 | /usr/share/cmake/GtkDoc
|
---|
[c1add1f5] | 189 | </seg>
|
---|
[effdc6af] | 190 | </seglistitem>
|
---|
| 191 | </segmentedlist>
|
---|
[fc7afd0c] | 192 |
|
---|
[effdc6af] | 193 | <variablelist>
|
---|
| 194 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 195 | <?dbfo list-presentation="list"?>
|
---|
| 196 | <?dbhtml list-presentation="table"?>
|
---|
[fc7afd0c] | 197 |
|
---|
[effdc6af] | 198 | <varlistentry id="gtkdoc">
|
---|
| 199 | <term><command>gtkdoc*</command></term>
|
---|
| 200 | <listitem>
|
---|
[b7a85cd9] | 201 | <para>
|
---|
[8558044] | 202 | these are all shell, or
|
---|
[b7a85cd9] | 203 | <application>Python</application> scripts used by
|
---|
| 204 | package <filename>Makefile</filename> scripts to generate
|
---|
[4c24eb0a] | 205 | documentation for the package being built
|
---|
[b7a85cd9] | 206 | </para>
|
---|
[effdc6af] | 207 | <indexterm zone="gtk-doc gtkdoc">
|
---|
| 208 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
[fc7afd0c] | 212 |
|
---|
[effdc6af] | 213 | </variablelist>
|
---|
[fc7afd0c] | 214 |
|
---|
[effdc6af] | 215 | </sect2>
|
---|
[fc7afd0c] | 216 |
|
---|
[832650c] | 217 | </sect1>
|
---|