[0cf85fa] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 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 |
|
---|
[301c411] | 7 | <!ENTITY sc-htmlhelp-download-http "https://files.pythonhosted.org/packages/source/s/sphinxcontrib-htmlhelp/sphinxcontrib-htmlhelp-&sc-htmlhelp-version;.tar.gz">
|
---|
[036821b] | 8 | <!ENTITY sc-htmlhelp-download-ftp " ">
|
---|
[301c411] | 9 | <!ENTITY sc-htmlhelp-md5sum "70765b55395a3c20233631802902c840">
|
---|
| 10 | <!ENTITY sc-htmlhelp-size "27 KB">
|
---|
[72c62e4] | 11 | <!ENTITY sc-htmlhelp-buildsize "3.1 MB (add 26 MB for tests)">
|
---|
| 12 | <!ENTITY sc-htmlhelp-time "less than 0.1 SBU (with tests)">
|
---|
[0cf85fa] | 13 | ]>
|
---|
| 14 |
|
---|
[25ee667] | 15 | <sect2 id="sc-htmlhelp" xreflabel="sphinxcontrib-htmlhelp-&sc-htmlhelp-version;">
|
---|
[0cf85fa] | 16 |
|
---|
[036821b] | 17 | <title>Sphinxcontrib-htmlhelp-&sc-htmlhelp-version;</title>
|
---|
[0cf85fa] | 18 |
|
---|
[036821b] | 19 | <indexterm zone="sc-htmlhelp">
|
---|
| 20 | <primary sortas="a-sphinxcontrib-htmlhelp">sphinxcontrib-htmlhelp</primary>
|
---|
[0cf85fa] | 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
[036821b] | 24 | <title>Introduction to Sphinxcontrib-htmlhelp Module</title>
|
---|
[0cf85fa] | 25 |
|
---|
| 26 | <para>
|
---|
[036821b] | 27 | The <application>Sphinxcontrib-htmlhelp</application> package is a
|
---|
| 28 | <application>Sphinx</application> extension which renders HTML
|
---|
| 29 | help files.
|
---|
[0cf85fa] | 30 | </para>
|
---|
| 31 |
|
---|
| 32 | &lfs112_checked;
|
---|
| 33 |
|
---|
| 34 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
[036821b] | 38 | Download (HTTP): <ulink url="&sc-htmlhelp-download-http;"/>
|
---|
[0cf85fa] | 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
[036821b] | 43 | Download (FTP): <ulink url="&sc-htmlhelp-download-ftp;"/>
|
---|
[0cf85fa] | 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
[036821b] | 48 | Download MD5 sum: &sc-htmlhelp-md5sum;
|
---|
[0cf85fa] | 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
[036821b] | 53 | Download size: &sc-htmlhelp-size;
|
---|
[0cf85fa] | 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
[036821b] | 58 | Estimated disk space required: &sc-htmlhelp-buildsize;
|
---|
[0cf85fa] | 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
[036821b] | 63 | Estimated build time: &sc-htmlhelp-time;
|
---|
[0cf85fa] | 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
[036821b] | 68 | <bridgehead renderas="sect4">Sphinxcontrib-htmlhelp Dependencies</bridgehead>
|
---|
[0cf85fa] | 69 |
|
---|
[74434cc] | 70 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
[0cf85fa] | 71 | <para role="optional">
|
---|
[72c62e4] | 72 | <xref linkend="pytest"/>,
|
---|
| 73 | <xref linkend="sphinx"/> (circular dependency), and
|
---|
[74434cc] | 74 | <ulink url="https://pypi.org/project/html5lib/">html5lib</ulink>
|
---|
[0cf85fa] | 75 | </para>
|
---|
| 76 |
|
---|
| 77 | </sect3>
|
---|
| 78 |
|
---|
| 79 | <sect3 role="installation">
|
---|
[036821b] | 80 | <title>Installation of Sphinxcontrib-htmlhelp</title>
|
---|
[0cf85fa] | 81 |
|
---|
| 82 | <para> Build the module: </para>
|
---|
| 83 |
|
---|
| 84 | <screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
| 85 |
|
---|
| 86 | <para>
|
---|
[74434cc] | 87 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[0cf85fa] | 88 | </para>
|
---|
| 89 |
|
---|
[74434cc] | 90 | <screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinxcontrib-htmlhelp</userinput></screen>
|
---|
| 91 |
|
---|
[0cf85fa] | 92 | <para>
|
---|
[74434cc] | 93 | Assuming <xref linkend="pytest"/> is installed, but the other optional
|
---|
| 94 | dependency is not, the installation can be tested with the following
|
---|
| 95 | commands:
|
---|
[0cf85fa] | 96 | </para>
|
---|
| 97 |
|
---|
[74434cc] | 98 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 99 | source testenv/bin/activate &&
|
---|
| 100 | pip3 install html5lib &&
|
---|
| 101 | sed -i 's/text()/read_&/' tests/test_htmlhelp.py &&
|
---|
| 102 | python3 /usr/bin/pytest<!-- no && because of a possible error -->
|
---|
| 103 | deactivate</userinput></screen>
|
---|
| 104 |
|
---|
| 105 | <para>
|
---|
| 106 | the <command>sed ...</command> command is needed because of a change
|
---|
| 107 | in <application>Sphinx</application> API for versions greater than
|
---|
| 108 | 5.0.
|
---|
| 109 | </para>
|
---|
[0cf85fa] | 110 |
|
---|
| 111 | </sect3>
|
---|
| 112 |
|
---|
| 113 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 114 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 115 |
|
---|
| 116 | <sect3 role="content">
|
---|
| 117 | <title>Contents</title>
|
---|
| 118 |
|
---|
| 119 | <segmentedlist>
|
---|
| 120 | <segtitle>Installed Programs</segtitle>
|
---|
| 121 | <segtitle>Installed Libraries</segtitle>
|
---|
| 122 | <segtitle>Installed Directories</segtitle>
|
---|
| 123 |
|
---|
| 124 | <seglistitem>
|
---|
[036821b] | 125 | <seg>None</seg>
|
---|
[0cf85fa] | 126 | <seg>None</seg>
|
---|
| 127 | <seg>
|
---|
[036821b] | 128 | /usr/lib/python&python3-majorver;/site-packages/sphinxcontrib and
|
---|
[301c411] | 129 | /usr/lib/python&python3-majorver;/site-packages/sphinxcontrib_htmlhelp-&sc-htmlhelp-version;.dist-info
|
---|
[0cf85fa] | 130 | </seg>
|
---|
| 131 | </seglistitem>
|
---|
| 132 | </segmentedlist>
|
---|
[036821b] | 133 |
|
---|
[0cf85fa] | 134 | </sect3>
|
---|
| 135 |
|
---|
| 136 | </sect2>
|
---|