mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-02-04 23:47:18 +08:00
569925c77f
Move the pythonhoted page to python_modules even though it is not yet activated to render in the book. Change location of pythonhosted md5sum ENTITIES to packages.ent so they can be used in multiple pages but only need to be updated in one place. Note that pages not have entries like: <!ENTITY asciidoc-md5sum "&asciidoc-md5sum;"> so this seems to be redefinig the entity to the version in packages.ent. This seems to be OK with the build system.
150 lines
4.6 KiB
XML
150 lines
4.6 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../../../general.ent">
|
|
%general-entities;
|
|
|
|
<!ENTITY gi-docgen-download-http "https://files.pythonhosted.org/packages/source/g/gi-docgen/gi-docgen-&gi-docgen-version;.tar.gz">
|
|
<!ENTITY gi-docgen-download-ftp " ">
|
|
<!ENTITY gi-docgen-md5sum "&gi-docgen-md5sum;">
|
|
<!ENTITY gi-docgen-size "2.4 MB">
|
|
<!ENTITY gi-docgen-buildsize "19 MB (with tests)">
|
|
<!ENTITY gi-docgen-time "less than 0.1 SBU (with tests)">
|
|
]>
|
|
|
|
<sect2 id="gi-docgen" xreflabel="Gi-DocGen-&gi-docgen-version;">
|
|
|
|
<title>Gi-DocGen-&gi-docgen-version;</title>
|
|
|
|
<indexterm zone="gi-docgen">
|
|
<primary sortas="a-gi-docgen">gi-docgen</primary>
|
|
</indexterm>
|
|
|
|
<sect3 role="package">
|
|
<title>Introduction to Gi-DocGen Module</title>
|
|
|
|
<para>
|
|
<application>Gi-DocGen</application> is a document generator for
|
|
GObject-based libraries. GObject is the base type system of the GNOME
|
|
project. GI-Docgen reuses the introspection data generated by
|
|
GObject-based libraries to generate the API reference of these
|
|
libraries, as well as other ancillary documentation.
|
|
</para>
|
|
|
|
&lfs112_checked;
|
|
|
|
<bridgehead renderas="sect4">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>
|
|
Download (HTTP): <ulink url="&gi-docgen-download-http;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download (FTP): <ulink url="&gi-docgen-download-ftp;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download MD5 sum: &gi-docgen-md5sum;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download size: &gi-docgen-size;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated disk space required: &gi-docgen-buildsize;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated build time: &gi-docgen-time;
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect4">Gi-DocGen Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect5">Required</bridgehead>
|
|
<para role="required">
|
|
<xref linkend="markdown"/>,
|
|
<phrase revision="sysv"><xref linkend="MarkupSafe"/>,</phrase>
|
|
<xref linkend="pygments"/>,
|
|
<phrase revision="sysv"><xref linkend="Jinja2"/>,</phrase>
|
|
and <xref linkend="typogrify"/>
|
|
</para>
|
|
|
|
<bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
|
<para role="optional">
|
|
<xref linkend="pytest"/>
|
|
</para>
|
|
|
|
</sect3>
|
|
|
|
<sect3 role="installation">
|
|
<title>Installation of gi-docgen</title>
|
|
|
|
<para> Build the module: </para>
|
|
|
|
<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
|
|
|
<para>
|
|
Now, as the <systemitem class="username">root</systemitem> user:
|
|
</para>
|
|
|
|
<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user gi-docgen</userinput></screen>
|
|
|
|
<para>
|
|
To test the installation, issue <command>pytest</command>.
|
|
</para>
|
|
|
|
</sect3>
|
|
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
href="../../../xincludes/pip3-cmd-explain.xml"/>
|
|
|
|
<sect3 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Libraries</segtitle>
|
|
<segtitle>Installed Directories</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>gi-docgen</seg>
|
|
<seg>None</seg>
|
|
<seg>
|
|
/usr/lib/python&python3-majorver;/site-packages/gidocgen and
|
|
/usr/lib/python&python3-majorver;/site-packages/gi_docgen-&gi-docgen-version;.dist-info
|
|
</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="gi-docgen-prog">
|
|
<term><command>gi-docgen</command></term>
|
|
<listitem>
|
|
<para>
|
|
manages documentation for libgobject based libraries.
|
|
</para>
|
|
<indexterm zone="gi-docgen gi-docgen-prog">
|
|
<primary sortas="b-gi-docgen">gi-docgen</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|