source: general/prog/python-dependencies/sphinxcontrib-htmlhelp.xml@ 569925c7

<?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://files.pythonhosted.org/packages/source/s/sphinxcontrib-htmlhelp/sphinxcontrib-htmlhelp-&sc-htmlhelp-version;.tar.gz">
  <!ENTITY sc-htmlhelp-download-ftp  " ">
  <!ENTITY sc-htmlhelp-md5sum        "&sc-htmlhelp-md5sum;">
  <!ENTITY sc-htmlhelp-size          "27 KB">
  <!ENTITY sc-htmlhelp-buildsize     "3.1 MB (add 26 MB for tests)">
  <!ENTITY sc-htmlhelp-time          "less than 0.1 SBU (with tests)">
]>

  <sect2 id="sc-htmlhelp" xreflabel="sphinxcontrib-htmlhelp-&sc-htmlhelp-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 (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/>,
        <xref linkend="sphinx"/> (circular dependency), and
        <ulink url="https://pypi.org/project/html5lib/">html5lib</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>
      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>

    <para>
      Assuming <xref linkend="pytest"/> is installed, but the other optional
      dependency is not, the installation can be tested with the following
      commands:
    </para>

<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv   &amp;&amp;
source testenv/bin/activate                      &amp;&amp;
pip3 install html5lib                            &amp;&amp;
sed -i 's/text()/read_&amp;/' tests/test_htmlhelp.py &amp;&amp;
python3 /usr/bin/pytest<!-- no && because of a possible error -->
deactivate</userinput></screen>

    <para>
      the <command>sed ...</command> command is needed because of a change
      in <application>Sphinx</application> API for versions greater than
      5.0.
    </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_htmlhelp-&sc-htmlhelp-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>