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