glfs/general/prog/python-dependencies/sphinxcontrib-htmlhelp.xml
2022-10-02 22:50:11 +02:00

132 lines
4.0 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 sc-htmlhelp-download-http "https://github.com/sphinx-doc/sphinxcontrib-htmlhelp/archive/refs/tags/&sc-htmlhelp-version;/sphinxcontrib-htmlhelp-&sc-htmlhelp-version;.tar.gz">
<!ENTITY sc-htmlhelp-download-ftp " ">
<!ENTITY sc-htmlhelp-md5sum "cb68f8a134e2954b9dba5b8f214c1be5">
<!ENTITY sc-htmlhelp-size "23 KB">
<!ENTITY sc-htmlhelp-buildsize "2.6 MB">
<!ENTITY sc-htmlhelp-time "less than 0.1 SBU">
]>
<sect2 id="sc-htmlhelp" xreflabel="sphinxcontrib-htmlhelp-&asciidoc-version;">
<title>Sphinxcontrib-htmlhelp-&sc-htmlhelp-version;</title>
<indexterm zone="sc-htmlhelp">
<primary sortas="a-sphinxcontrib-htmlhelp">sphinxcontrib-htmlhelp</primary>
</indexterm>
<sect3 role="package">
<title>Introduction to Sphinxcontrib-htmlhelp Module</title>
<para>
The <application>Sphinxcontrib-htmlhelp</application> package is a
<application>Sphinx</application> extension which renders HTML
help files.
</para>
&lfs112_checked;
<bridgehead renderas="sect4">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&sc-htmlhelp-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&sc-htmlhelp-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &sc-htmlhelp-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &sc-htmlhelp-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &sc-htmlhelp-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &sc-htmlhelp-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect4">Sphinxcontrib-htmlhelp Dependencies</bridgehead>
<bridgehead renderas="sect5">Optional</bridgehead>
<para role="optional">
<xref linkend="pytest"/> (for tests),
<ulink url="https://pypi.org/project/docutils-stubs/">
docutils-stubs
</ulink>,
<ulink url="https://pypi.org/project/flake8/">
flake8
</ulink>,
<ulink url="https://pypi.org/project/html5lib/">
html5lib
</ulink> (for tests), and
<ulink url="https://pypi.org/project/mypy/">
mypy
</ulink>
</para>
</sect3>
<sect3 role="installation">
<title>Installation of Sphinxcontrib-htmlhelp</title>
<para> Build the module: </para>
<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
<para>
This package does not come with a test suite.
</para>
<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 sphinxcontrib-htmlhelp</userinput></screen>
</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_htmlhelp-&sc-htmlhelp-dev-version;.dist-info
</seg>
</seglistitem>
</segmentedlist>
</sect3>
</sect2>