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