glfs/general/prog/python-dependencies/sphinxcontrib-devhelp.xml
2024-01-19 22:39:35 +01:00

122 lines
3.6 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!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 sc-devhelp-download-http "https://files.pythonhosted.org/packages/source/s/sphinxcontrib-devhelp/sphinxcontrib-devhelp-&sc-devhelp-version;.tar.gz">
<!ENTITY sc-devhelp-download-ftp " ">
<!ENTITY sc-devhelp-md5sum "&sc-devhelp-md5sum;">
<!ENTITY sc-devhelp-size "17 KB">
<!ENTITY sc-devhelp-buildsize "2.7 MB (with tests)">
<!ENTITY sc-devhelp-time "less than 0.1 SBU (with tests)">
]>
<sect2 id="sc-devhelp" xreflabel="sphinxcontrib-devhelp-&sc-devhelp-version;">
<title>Sphinxcontrib-devhelp-&sc-devhelp-version;</title>
<indexterm zone="sc-devhelp">
<primary sortas="a-sphinxcontrib-devhelp">sphinxcontrib-devhelp</primary>
</indexterm>
<sect3 role="package">
<title>Introduction to Sphinxcontrib-devhelp Module</title>
<para>
The <application>Sphinxcontrib-devhelp</application> package is a
<application>Sphinx</application> extension which outputs
<ulink url="https://wiki.gnome.org/Apps/Devhelp">Devhelp</ulink>
documents.
</para>
&lfs120_checked;
<bridgehead renderas="sect4">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&sc-devhelp-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&sc-devhelp-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &sc-devhelp-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &sc-devhelp-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &sc-devhelp-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &sc-devhelp-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect4">Sphinxcontrib-devhelp Dependencies</bridgehead>
<bridgehead renderas="sect5">Optional (for testing)</bridgehead>
<para role="optional">
<xref linkend="pytest"/> and
<xref linkend="sphinx"/> (circular dependency)
</para>
</sect3>
<sect3 role="installation">
<title>Installation of Sphinxcontrib-devhelp</title>
<para> Build the module: </para>
&build-wheel;
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>&install-wheel; sphinxcontrib-devhelp</userinput></screen>
<para>
To test the installation, run <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>None</seg>
<seg>None</seg>
<seg>
/usr/lib/python&python3-majorver;/site-packages/sphinxcontrib and
/usr/lib/python&python3-majorver;/site-packages/sphinxcontrib_devhelp-&sc-devhelp-version;.dist-info
</seg>
</seglistitem>
</segmentedlist>
</sect3>
</sect2>