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 sphinx-download-http "https://files.pythonhosted.org/packages/source/s/sphinx/sphinx-&sphinx-version;.tar.gz">
|
---|
8 | <!ENTITY sphinx-download-ftp " ">
|
---|
9 | <!ENTITY sphinx-md5sum "845210d4c36be0dac08ec2ce2411a194">
|
---|
10 | <!ENTITY sphinx-size "7.8 MB">
|
---|
11 | <!ENTITY sphinx-buildsize "30 MB (add 22 MB for tests)">
|
---|
12 | <!ENTITY sphinx-time "less than 0.1 SBU (add 0.7 SBU for tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect2 id="sphinx" xreflabel="sphinx-&sphinx-version;">
|
---|
16 |
|
---|
17 | <title>Sphinx-&sphinx-version;</title>
|
---|
18 |
|
---|
19 | <indexterm zone="sphinx">
|
---|
20 | <primary sortas="a-sphinx">sphinx</primary>
|
---|
21 | </indexterm>
|
---|
22 |
|
---|
23 | <sect3 role="package">
|
---|
24 | <title>Introduction to Sphinx Module</title>
|
---|
25 |
|
---|
26 | <para>
|
---|
27 | The <application>Sphinx</application> package is a set of tools
|
---|
28 | for translating some structured text formats into pretty documentation
|
---|
29 | in various formats.
|
---|
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="&sphinx-download-http;"/>
|
---|
39 | </para>
|
---|
40 | </listitem>
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (FTP): <ulink url="&sphinx-download-ftp;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download MD5 sum: &sphinx-md5sum;
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download size: &sphinx-size;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Estimated disk space required: &sphinx-buildsize;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated build time: &sphinx-time;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | </itemizedlist>
|
---|
67 |
|
---|
68 | <bridgehead renderas="sect4">Sphinx Dependencies</bridgehead>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
71 | <para role="required">
|
---|
72 | <xref linkend="alabaster"/>,
|
---|
73 | <xref linkend="babel"/>,
|
---|
74 | <xref linkend="docutils"/>,
|
---|
75 | <xref linkend="imagesize"/>,
|
---|
76 | <xref linkend="packaging"/>,
|
---|
77 | <xref linkend="pygments"/>,
|
---|
78 | <xref linkend="requests"/>,
|
---|
79 | <xref linkend="snowballstemmer"/>,
|
---|
80 | <xref linkend="sc-applehelp"/>,
|
---|
81 | <xref linkend="sc-devhelp"/>,
|
---|
82 | <xref linkend="sc-htmlhelp"/>,
|
---|
83 | <xref linkend="sc-jsmath"/>,
|
---|
84 | <xref linkend="sc-qthelp"/>, and
|
---|
85 | <xref linkend="sc-serializinghtml"/>
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect5">Optional (for tests)</bridgehead>
|
---|
89 | <para role="optional">
|
---|
90 | <xref linkend="cython"/>,
|
---|
91 | <xref linkend="html5lib"/>,
|
---|
92 | <xref linkend="pytest"/>,
|
---|
93 | <xref linkend="texlive"/>,
|
---|
94 | <ulink url="https://pypi.org/project/defusedxml/">defusedxml</ulink>, and
|
---|
95 | <ulink url="https://pypi.org/project/typing_extensions/">typing_extensions</ulink>
|
---|
96 | </para>
|
---|
97 |
|
---|
98 | </sect3>
|
---|
99 |
|
---|
100 | <sect3 role="installation">
|
---|
101 | <title>Installation of Sphinx</title>
|
---|
102 |
|
---|
103 | <para>Build the module:</para>
|
---|
104 |
|
---|
105 | &build-wheel;
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
109 | </para>
|
---|
110 |
|
---|
111 | <screen role="root"><userinput>&install-wheel; sphinx</userinput></screen>
|
---|
112 |
|
---|
113 | <para>
|
---|
114 | Assuming <xref linkend="cython"/> and <xref linkend="pytest"/> are
|
---|
115 | installed, but the other optional dependencies are not, the installation
|
---|
116 | can be tested with the following commands:
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
120 | source testenv/bin/activate &&
|
---|
121 | pip3 install sphinx[test] &&
|
---|
122 | python3 -m pytest<!-- no && because of a possible error -->
|
---|
123 | deactivate</userinput></screen>
|
---|
124 | <!-- No failure in 7.0.1 [pierre]
|
---|
125 | 7.1.0: 4 failed, 1896 passed, 10 skipped in 108.14s (0:01:48)
|
---|
126 | test_imgmath_png, test_imgmath_svg, test_imgmath_svg_embed, test_imgmath_numfig_html
|
---|
127 | 7.2.5: 2051 passed, 11 skipped, 4 warnings [pierre]
|
---|
128 | 7.2.6: 2052 passed, 10 skipped, 6 warnings [pierre]
|
---|
129 | 7.3.7: 2124 passed, 20 skipped, 35 warnings in 123.27s [bdubbs]
|
---|
130 | 8.1.0: 5 failed, 2257 passed, 16 skipped, 6 warnings in 60.34s [bdubbs]
|
---|
131 | FAILED tests/test_extensions/test_ext_math.py::test_imgmath_png - assert None
|
---|
132 | FAILED tests/test_extensions/test_ext_math.py::test_imgmath_svg - assert None
|
---|
133 | FAILED tests/test_extensions/test_ext_math.py::test_imgmath_svg_embed - assert None
|
---|
134 | FAILED tests/test_extensions/test_ext_math.py::test_imgmath_numfig_html -
|
---|
135 | assert '<span class="eqno">(3)<a class="headerlink" href="#equation-bar"'
|
---|
136 | in '<!DOCTYPE html>\...
|
---|
137 | FAILED tests/test_util/test_util_i18n.py::test_format_date_timezone
|
---|
138 | 8.1.3: 5 failed, 2258 passed, 16 skipped, 6 warnings in 60.15s [bdubbs]
|
---|
139 | -->
|
---|
140 | </sect3>
|
---|
141 |
|
---|
142 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
143 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
144 |
|
---|
145 | <sect3 role="content">
|
---|
146 | <title>Contents</title>
|
---|
147 |
|
---|
148 | <segmentedlist>
|
---|
149 | <segtitle>Installed Programs</segtitle>
|
---|
150 | <segtitle>Installed Libraries</segtitle>
|
---|
151 | <segtitle>Installed Directories</segtitle>
|
---|
152 |
|
---|
153 | <seglistitem>
|
---|
154 | <seg>
|
---|
155 | sphinx-apidoc, sphinx-autogen, sphinx-build, and sphinx-quickstart
|
---|
156 | </seg>
|
---|
157 | <seg>None</seg>
|
---|
158 | <seg>
|
---|
159 | /usr/lib/python&python3-majorver;/site-packages/sphinx and
|
---|
160 | /usr/lib/python&python3-majorver;/site-packages/sphinx-&sphinx-version;.dist-info
|
---|
161 | </seg>
|
---|
162 | </seglistitem>
|
---|
163 | </segmentedlist>
|
---|
164 |
|
---|
165 | <variablelist>
|
---|
166 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
167 | <?dbfo list-presentation="list"?>
|
---|
168 | <?dbhtml list-presentation="table"?>
|
---|
169 |
|
---|
170 | <varlistentry id="sphinx-apidoc">
|
---|
171 | <term><command>sphinx-apidoc</command></term>
|
---|
172 | <listitem>
|
---|
173 | <para>
|
---|
174 | creates an reST file from python modules and packages
|
---|
175 | </para>
|
---|
176 | <indexterm zone="sphinx sphinx-apidoc">
|
---|
177 | <primary sortas="b-sphinx-apidoc">sphinx-apidoc</primary>
|
---|
178 | </indexterm>
|
---|
179 | </listitem>
|
---|
180 | </varlistentry>
|
---|
181 |
|
---|
182 | <varlistentry id="sphinx-autogen">
|
---|
183 | <term><command>sphinx-autogen</command></term>
|
---|
184 | <listitem>
|
---|
185 | <para>
|
---|
186 | generates ReStructuredText from special directives contained
|
---|
187 | in given input files
|
---|
188 | </para>
|
---|
189 | <indexterm zone="sphinx sphinx-autogen">
|
---|
190 | <primary sortas="b-sphinx-autogen">sphinx-autogen</primary>
|
---|
191 | </indexterm>
|
---|
192 | </listitem>
|
---|
193 | </varlistentry>
|
---|
194 |
|
---|
195 | <varlistentry id="sphinx-build">
|
---|
196 | <term><command>sphinx-build</command></term>
|
---|
197 | <listitem>
|
---|
198 | <para>
|
---|
199 | generates documentation in various formats from ReStructuredText
|
---|
200 | source files
|
---|
201 | </para>
|
---|
202 | <indexterm zone="sphinx sphinx-build">
|
---|
203 | <primary sortas="b-sphinx-build">sphinx-build</primary>
|
---|
204 | </indexterm>
|
---|
205 | </listitem>
|
---|
206 | </varlistentry>
|
---|
207 |
|
---|
208 | <varlistentry id="sphinx-quickstart">
|
---|
209 | <term><command>sphinx-quickstart</command></term>
|
---|
210 | <listitem>
|
---|
211 | <para>
|
---|
212 | generates required files for a sphinx project
|
---|
213 | </para>
|
---|
214 | <indexterm zone="sphinx sphinx-quickstart">
|
---|
215 | <primary sortas="b-sphinx-quickstart">sphinx-quickstart</primary>
|
---|
216 | </indexterm>
|
---|
217 | </listitem>
|
---|
218 | </varlistentry>
|
---|
219 |
|
---|
220 | </variablelist>
|
---|
221 |
|
---|
222 | </sect3>
|
---|
223 |
|
---|
224 | </sect2>
|
---|