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