1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
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">
|
---|
9 | <!ENTITY gtk-doc-md5sum "07764836262e154e94922e5f2aa476ae">
|
---|
10 | <!ENTITY gtk-doc-size "748 KB">
|
---|
11 | <!ENTITY gtk-doc-buildsize "14 MB (with tests)">
|
---|
12 | <!ENTITY gtk-doc-time "0.2 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
---|
16 | <?dbhtml filename="gtk-doc.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>GTK-Doc->k-doc-version;</title>
|
---|
24 |
|
---|
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>
|
---|
31 |
|
---|
32 | <para>The <application>GTK-Doc</application> package
|
---|
33 | contains a code documenter. This is useful for extracting specially formatted
|
---|
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
|
---|
38 | available, the install process will copy any pre-built documentation to your
|
---|
39 | system.</para>
|
---|
40 |
|
---|
41 | &lfs90_checked;
|
---|
42 |
|
---|
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>
|
---|
64 |
|
---|
65 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
66 |
|
---|
67 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
68 | <para role="required">
|
---|
69 | <xref linkend="DocBook"/>,
|
---|
70 | <xref linkend="docbook-xsl"/>,
|
---|
71 | <xref linkend="itstool"/>, and
|
---|
72 | <xref linkend="libxslt"/>
|
---|
73 | </para>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
76 | <para role="recommended">
|
---|
77 | <xref role="runtime" linkend="pygments"/> at run time
|
---|
78 | </para>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
81 | <para role="optional">
|
---|
82 | For tests:
|
---|
83 | <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
|
---|
84 | <xref linkend="fop"/> (XML PDF support),
|
---|
85 | <xref linkend="glib2"/>,
|
---|
86 | <xref linkend="which"/>, and
|
---|
87 | Python modules
|
---|
88 | <xref linkend="lxml"/>,
|
---|
89 | <ulink url="https://anytree.readthedocs.io/en/latest/">anytree</ulink>, and
|
---|
90 | <ulink url="https://pypi.org/project/parameterized/">parameterized</ulink>
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <note><para>The optional python modules above can be easily installed with
|
---|
94 | the <command>pip3</command> command.</para></note>
|
---|
95 |
|
---|
96 | <para condition="html" role="usernotes">User Notes:
|
---|
97 | <ulink url="&blfs-wiki;/gtk-doc"/></para>
|
---|
98 |
|
---|
99 | </sect2>
|
---|
100 |
|
---|
101 | <sect2 role="installation">
|
---|
102 | <title>Installation of GTK-Doc</title>
|
---|
103 |
|
---|
104 | <para>Install <application>GTK-Doc</application> by running
|
---|
105 | the following commands:</para>
|
---|
106 |
|
---|
107 | <screen><userinput>./configure --prefix=/usr &&
|
---|
108 | make</userinput></screen>
|
---|
109 |
|
---|
110 | <para>The test suite will hang if the package (or a previous version)
|
---|
111 | is not already installed.</para>
|
---|
112 |
|
---|
113 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
114 |
|
---|
115 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
116 |
|
---|
117 | <para>To test the results, issue: <command>make check</command>.
|
---|
118 | Some tests will fail depending on optionally installed packages.</para>
|
---|
119 |
|
---|
120 | </sect2>
|
---|
121 |
|
---|
122 | <sect2 role="content">
|
---|
123 | <title>Contents</title>
|
---|
124 |
|
---|
125 | <segmentedlist>
|
---|
126 | <segtitle>Installed Programs</segtitle>
|
---|
127 | <segtitle>Installed Libraries</segtitle>
|
---|
128 | <segtitle>Installed Directories</segtitle>
|
---|
129 |
|
---|
130 | <seglistitem>
|
---|
131 | <seg>
|
---|
132 | gtkdocize,
|
---|
133 | gtkdoc-check,
|
---|
134 | gtkdoc-depscan,
|
---|
135 | gtkdoc-fixxref,
|
---|
136 | gtkdoc-mkdb,
|
---|
137 | gtkdoc-mkhtml,
|
---|
138 | gtkdoc-mkhtml2,
|
---|
139 | gtkdoc-mkman,
|
---|
140 | gtkdoc-mkpdf,
|
---|
141 | gtkdoc-rebase,
|
---|
142 | gtkdoc-scan, and
|
---|
143 | gtkdoc-scangobj
|
---|
144 | </seg>
|
---|
145 |
|
---|
146 | <seg>None</seg>
|
---|
147 |
|
---|
148 | <seg>
|
---|
149 | /usr/share/gtk-doc and
|
---|
150 | /usr/share/help/*/gtk-doc-manual
|
---|
151 | </seg>
|
---|
152 | </seglistitem>
|
---|
153 | </segmentedlist>
|
---|
154 |
|
---|
155 | <variablelist>
|
---|
156 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
157 | <?dbfo list-presentation="list"?>
|
---|
158 | <?dbhtml list-presentation="table"?>
|
---|
159 |
|
---|
160 | <varlistentry id="gtkdoc">
|
---|
161 | <term><command>gtkdoc*</command></term>
|
---|
162 | <listitem>
|
---|
163 | <para>these are all shell, or
|
---|
164 | <application>Python</application> scripts used by
|
---|
165 | package <filename>Makefile</filename> scripts to generate
|
---|
166 | documentation for the package being built.</para>
|
---|
167 | <indexterm zone="gtk-doc gtkdoc">
|
---|
168 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
169 | </indexterm>
|
---|
170 | </listitem>
|
---|
171 | </varlistentry>
|
---|
172 |
|
---|
173 | </variablelist>
|
---|
174 |
|
---|
175 | </sect2>
|
---|
176 |
|
---|
177 | </sect1>
|
---|