[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 |
|
---|
[6a513a4] | 7 | <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.xz">
|
---|
| 8 | <!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.xz">
|
---|
[b7279d4] | 9 | <!ENTITY gtk-doc-md5sum "1045ba29ca0693ced2045523407aae4c">
|
---|
| 10 | <!ENTITY gtk-doc-size "740 KB">
|
---|
| 11 | <!ENTITY gtk-doc-buildsize "17 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 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[fc7afd0c] | 22 |
|
---|
[effdc6af] | 23 | <title>GTK-Doc->k-doc-version;</title>
|
---|
[fc7afd0c] | 24 |
|
---|
[effdc6af] | 25 | <indexterm zone="gtk-doc">
|
---|
| 26 | <primary sortas="a-GTK-Doc">GTK-Doc</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to GTK-Doc</title>
|
---|
[fc7afd0c] | 31 |
|
---|
[8d77de6] | 32 | <para>The <application>GTK-Doc</application> package
|
---|
[104733c] | 33 | contains a code documenter. This is useful for extracting specially formatted
|
---|
[8d77de6] | 34 | comments from the code to create API documentation. This
|
---|
| 35 | package is <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
| 36 | not build the documentation. This does not mean that you will not have any
|
---|
| 37 | documentation. If <application>GTK-Doc</application> is not
|
---|
[d9962703] | 38 | available, the install process will copy any pre-built documentation to your
|
---|
[effdc6af] | 39 | system.</para>
|
---|
[fc7afd0c] | 40 |
|
---|
[38489aa0] | 41 | &lfs84_checked;
|
---|
[a10f4a7] | 42 |
|
---|
[effdc6af] | 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (HTTP): <ulink url=">k-doc-download-http;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (FTP): <ulink url=">k-doc-download-ftp;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download MD5 sum: >k-doc-md5sum;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download size: >k-doc-size;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated disk space required: >k-doc-buildsize;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated build time: >k-doc-time;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
[fc7afd0c] | 64 |
|
---|
[effdc6af] | 65 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
[fc7afd0c] | 66 |
|
---|
[07f61e4] | 67 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 68 | <para role="recommended">
|
---|
| 69 | <xref role="runtime" linkend="pygments"/> at run time
|
---|
| 70 | </para>
|
---|
| 71 |
|
---|
[effdc6af] | 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[ba056d7] | 73 | <para role="required">
|
---|
| 74 | <xref linkend="DocBook"/>,
|
---|
| 75 | <xref linkend="docbook-xsl"/>,
|
---|
[0367db7] | 76 | <xref linkend="itstool"/>, and
|
---|
| 77 | <xref linkend="libxslt"/>
|
---|
[ba056d7] | 78 | </para>
|
---|
[64c6acb] | 79 |
|
---|
[effdc6af] | 80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b495000] | 81 | <para role="optional">
|
---|
[b7279d4] | 82 | For tests:
|
---|
[665ac79f] | 83 | <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
|
---|
| 84 | <xref linkend="fop"/> (XML PDF support),
|
---|
[b7279d4] | 85 | <xref linkend="glib2"/>,
|
---|
| 86 | <xref linkend="which"/>, and
|
---|
| 87 | Python modules
|
---|
| 88 | <ulink url="https://anytree.readthedocs.io/en/latest/">anytree</ulink>, and
|
---|
[c48b85a1] | 89 | <ulink url="https://pypi.org/project/parameterized/">parameterized</ulink>
|
---|
[665ac79f] | 90 | </para>
|
---|
[fc7afd0c] | 91 |
|
---|
[b7279d4] | 92 | <note><para>The optional python modules above can be easily installed with
|
---|
| 93 | the <command>pip3</command> command.</para></note>
|
---|
| 94 |
|
---|
[1039de3] | 95 | <para condition="html" role="usernotes">User Notes:
|
---|
| 96 | <ulink url="&blfs-wiki;/gtk-doc"/></para>
|
---|
| 97 |
|
---|
[effdc6af] | 98 | </sect2>
|
---|
[fc7afd0c] | 99 |
|
---|
[effdc6af] | 100 | <sect2 role="installation">
|
---|
| 101 | <title>Installation of GTK-Doc</title>
|
---|
| 102 |
|
---|
[8d77de6] | 103 | <para>Install <application>GTK-Doc</application> by running
|
---|
[effdc6af] | 104 | the following commands:</para>
|
---|
| 105 |
|
---|
[f47c5167] | 106 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[2e46c65] | 107 | make</userinput></screen>
|
---|
| 108 |
|
---|
[b7279d4] | 109 | <para>To test the results, issue: <command>make check</command>.
|
---|
| 110 | Some tests will fail depending on optionally installed packages.</para>
|
---|
[0e5a229a] | 111 |
|
---|
[effdc6af] | 112 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[fc7afd0c] | 113 |
|
---|
[effdc6af] | 114 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[fc7afd0c] | 115 |
|
---|
[effdc6af] | 116 | </sect2>
|
---|
[fc7afd0c] | 117 |
|
---|
[effdc6af] | 118 | <sect2 role="content">
|
---|
| 119 | <title>Contents</title>
|
---|
| 120 |
|
---|
| 121 | <segmentedlist>
|
---|
| 122 | <segtitle>Installed Programs</segtitle>
|
---|
| 123 | <segtitle>Installed Libraries</segtitle>
|
---|
| 124 | <segtitle>Installed Directories</segtitle>
|
---|
[fc7afd0c] | 125 |
|
---|
[effdc6af] | 126 | <seglistitem>
|
---|
[b7279d4] | 127 | <seg>
|
---|
| 128 | gtkdocize,
|
---|
| 129 | gtkdoc-check,
|
---|
| 130 | gtkdoc-depscan,
|
---|
| 131 | gtkdoc-fixxref,
|
---|
| 132 | gtkdoc-mkdb,
|
---|
| 133 | gtkdoc-mkhtml,
|
---|
| 134 | gtkdoc-mkhtml2,
|
---|
| 135 | gtkdoc-mkman,
|
---|
| 136 | gtkdoc-mkpdf,
|
---|
| 137 | gtkdoc-rebase,
|
---|
| 138 | gtkdoc-scan, and
|
---|
| 139 | gtkdoc-scangobj
|
---|
| 140 | </seg>
|
---|
[c1add1f5] | 141 |
|
---|
[effdc6af] | 142 | <seg>None</seg>
|
---|
[c1add1f5] | 143 |
|
---|
[b7279d4] | 144 | <seg>
|
---|
| 145 | /usr/share/gtk-doc and
|
---|
| 146 | /usr/share/help/*/gtk-doc-manual
|
---|
[c1add1f5] | 147 | </seg>
|
---|
[effdc6af] | 148 | </seglistitem>
|
---|
| 149 | </segmentedlist>
|
---|
[fc7afd0c] | 150 |
|
---|
[effdc6af] | 151 | <variablelist>
|
---|
| 152 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 153 | <?dbfo list-presentation="list"?>
|
---|
| 154 | <?dbhtml list-presentation="table"?>
|
---|
[fc7afd0c] | 155 |
|
---|
[effdc6af] | 156 | <varlistentry id="gtkdoc">
|
---|
| 157 | <term><command>gtkdoc*</command></term>
|
---|
| 158 | <listitem>
|
---|
[c1add1f5] | 159 | <para>these are all shell, or
|
---|
[64c6acb] | 160 | <application>Python</application> scripts used by
|
---|
[8d77de6] | 161 | package <filename>Makefile</filename> scripts to generate
|
---|
[effdc6af] | 162 | documentation for the package being built.</para>
|
---|
| 163 | <indexterm zone="gtk-doc gtkdoc">
|
---|
| 164 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
| 165 | </indexterm>
|
---|
| 166 | </listitem>
|
---|
| 167 | </varlistentry>
|
---|
[fc7afd0c] | 168 |
|
---|
[effdc6af] | 169 | </variablelist>
|
---|
[fc7afd0c] | 170 |
|
---|
[effdc6af] | 171 | </sect2>
|
---|
[fc7afd0c] | 172 |
|
---|
[832650c] | 173 | </sect1>
|
---|