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