[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[8828c760] | 2 | <!DOCTYPE sect2 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 |
|
---|
[421e4739] | 7 | <!ENTITY gi-docgen-download-http "https://files.pythonhosted.org/packages/source/g/gi-docgen/gi_docgen-&gi-docgen-version;.tar.gz">
|
---|
[8828c760] | 8 | <!ENTITY gi-docgen-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY gi-docgen-md5sum "&gi-docgen-md5sum;">
|
---|
[0a13134f] | 10 | <!ENTITY gi-docgen-size "2.4 MB">
|
---|
[421e4739] | 11 | <!ENTITY gi-docgen-buildsize "17 MB (with tests)">
|
---|
[33f878a9] | 12 | <!ENTITY gi-docgen-time "less than 0.1 SBU (with tests)">
|
---|
[8828c760] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="gi-docgen" xreflabel="Gi-DocGen-&gi-docgen-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Gi-DocGen-&gi-docgen-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="gi-docgen">
|
---|
| 20 | <primary sortas="a-gi-docgen">gi-docgen</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Gi-DocGen Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
[e1dc8db] | 27 | <application>Gi-DocGen</application> is a document generator for
|
---|
[8828c760] | 28 | GObject-based libraries. GObject is the base type system of the GNOME
|
---|
[e343b67] | 29 | project. Gi-DocGen reuses the introspection data generated by
|
---|
[8828c760] | 30 | GObject-based libraries to generate the API reference of these
|
---|
| 31 | libraries, as well as other ancillary documentation.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[f822342] | 34 | &lfs122_checked;
|
---|
[8828c760] | 35 |
|
---|
| 36 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&gi-docgen-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&gi-docgen-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &gi-docgen-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &gi-docgen-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &gi-docgen-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &gi-docgen-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect4">Gi-DocGen Dependencies</bridgehead>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 73 | <para role="required">
|
---|
[0a13134f] | 74 | <xref linkend="markdown"/>,
|
---|
[674e73c] | 75 | <xref linkend="packaging"/>,
|
---|
[0a13134f] | 76 | <xref linkend="pygments"/>,
|
---|
[8f65da99] | 77 | and <xref linkend="typogrify"/>
|
---|
[8828c760] | 78 | </para>
|
---|
| 79 |
|
---|
[0977d61] | 80 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
[8828c760] | 81 | <para role="optional">
|
---|
[0977d61] | 82 | <xref role='runtime' linkend='graphviz'/> (runtime, for visualizing
|
---|
| 83 | class hierarchy graphs) and
|
---|
| 84 | <xref linkend="pytest"/> (for testing)
|
---|
[8828c760] | 85 | </para>
|
---|
| 86 |
|
---|
| 87 | </sect3>
|
---|
| 88 |
|
---|
| 89 | <sect3 role="installation">
|
---|
| 90 | <title>Installation of gi-docgen</title>
|
---|
| 91 |
|
---|
[0977d61] | 92 | <!-- https://gitlab.gnome.org/GNOME/gi-docgen/-/issues/188 -->
|
---|
| 93 | <para>
|
---|
| 94 | Silence a warning from the Graphviz <command>dot</command> utility
|
---|
| 95 | which will cause documentation of various packages fail to build
|
---|
| 96 | if Graphviz is installed but built without Pango, and
|
---|
| 97 | <command>gi-docgen</command> is invoked with the
|
---|
| 98 | <option>--fatal-warnings</option> option:
|
---|
| 99 | </para>
|
---|
| 100 |
|
---|
[421e4739] | 101 | <screen><userinput>sed -i '/if err:/s/err/proc.returncode/' gidocgen/utils.py</userinput></screen>
|
---|
[0977d61] | 102 |
|
---|
[8828c760] | 103 | <para> Build the module: </para>
|
---|
| 104 |
|
---|
[db244ae2] | 105 | &build-wheel;
|
---|
[8828c760] | 106 |
|
---|
| 107 | <para>
|
---|
| 108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
[db244ae2] | 111 | <screen role="root"><userinput>&install-wheel; gi-docgen</userinput></screen>
|
---|
[8828c760] | 112 |
|
---|
| 113 | <para>
|
---|
[33f878a9] | 114 | To test the installation, issue <command>pytest</command>.
|
---|
[8828c760] | 115 | </para>
|
---|
| 116 |
|
---|
| 117 | </sect3>
|
---|
| 118 |
|
---|
| 119 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 120 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 121 |
|
---|
| 122 | <sect3 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>
|
---|
[33f878a9] | 131 | <seg>gi-docgen</seg>
|
---|
[8828c760] | 132 | <seg>None</seg>
|
---|
| 133 | <seg>
|
---|
[33f878a9] | 134 | /usr/lib/python&python3-majorver;/site-packages/gidocgen and
|
---|
| 135 | /usr/lib/python&python3-majorver;/site-packages/gi_docgen-&gi-docgen-version;.dist-info
|
---|
[8828c760] | 136 | </seg>
|
---|
| 137 | </seglistitem>
|
---|
| 138 | </segmentedlist>
|
---|
| 139 |
|
---|
[33f878a9] | 140 | <variablelist>
|
---|
| 141 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 142 | <?dbfo list-presentation="list"?>
|
---|
| 143 | <?dbhtml list-presentation="table"?>
|
---|
| 144 |
|
---|
| 145 | <varlistentry id="gi-docgen-prog">
|
---|
| 146 | <term><command>gi-docgen</command></term>
|
---|
| 147 | <listitem>
|
---|
| 148 | <para>
|
---|
| 149 | manages documentation for libgobject based libraries.
|
---|
| 150 | </para>
|
---|
| 151 | <indexterm zone="gi-docgen gi-docgen-prog">
|
---|
| 152 | <primary sortas="b-gi-docgen">gi-docgen</primary>
|
---|
| 153 | </indexterm>
|
---|
| 154 | </listitem>
|
---|
| 155 | </varlistentry>
|
---|
| 156 |
|
---|
| 157 | </variablelist>
|
---|
| 158 |
|
---|
[8828c760] | 159 | </sect3>
|
---|
| 160 |
|
---|
| 161 | </sect2>
|
---|