source: general/prog/python-modules/docutils.xml@ 5b6899bd

gimp3 lazarus trunk
Last change on this file since 5b6899bd was 5b6899bd, checked in by Xi Ruoyao <xry111@…>, 3 months ago

docutils: Comment out unnecessary command, and add test instruction
  • Property mode set to 100644
File size: 10.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 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 docutils-download-http "https://files.pythonhosted.org/packages/source/d/docutils/docutils-&docutils-version;.tar.gz">
8 <!ENTITY docutils-download-ftp " ">
9 <!ENTITY docutils-md5sum "c4064e1e0e3cd142951fd2b95b830874">
10 <!ENTITY docutils-size "2.1 MB">
11 <!ENTITY docutils-buildsize "10 MB">
12 <!ENTITY docutils-time "less than 0.1 SBU">
13]>
14
15 <!-- Begin docutils -->
16 <sect2 id="docutils" xreflabel="docutils-&docutils-version;">
17
18 <title>docutils-&docutils-version;</title>
19
20 <indexterm zone="docutils">
21 <primary sortas="a-docutils">docutils</primary>
22 </indexterm>
23
24 <sect3 role="package">
25 <title>Introduction to docutils</title>
26
27 <para>
28 <application>docutils</application> is a set of
29 <application>Python</application> modules and programs
30 for processing plaintext docs into formats such as HTML, XML, or LaTeX.
31 </para>
32
33 &lfs121_checked;
34
35 <bridgehead renderas="sect4">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&docutils-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&docutils-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &docutils-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &docutils-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &docutils-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &docutils-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 </sect3>
70
71 <sect3 role="installation">
72 <title>Installation of docutils</title>
73
74<!-- Editors note: Use - -root= instead of DESTDIR= when updating. -->
75
76 <para>
77 First, remove some files installed in a previous version
78 that are no longer valid. As the &root; user:
79 </para>
80
81<screen role="root"><userinput>for f in /usr/bin/rst*.py; do
82 sudo rm -fv /usr/bin/$(basename $f .py)
83done</userinput></screen>
84
85 <para>
86 To build the <application>Python 3</application> applications,
87 run the following command:
88 </para>
89
90&build-wheel;
91
92 <para>
93 To install the <application>Python</application> applications
94 run the following as the &root; user:
95 </para>
96
97<screen role="root"><userinput>&install-wheel; docutils</userinput></screen>
98
99 <!-- FHS 3.0 section 4.4.2:
100 "There must be no subdirectories in /usr/bin."
101 But pip maintainers closed this as WONTFIX:
102 https://github.com/pypa/pip/issues/6906
103
104 No longer happening after the upstream removed .py suffix for
105 /usr/bin scripts
106 <para>
107 To reduce the time needed for loading Python scripts,
108 <command>pip3 install</command> will compile the scripts with
109 extension <filename class='extension'>.py</filename> into byte code
110 and save the result into
111 <filename class='extension'>.pyc</filename> files in the directory
112 <filename class='directory'>__pycache__</filename>.
113 But this package installs <filename class='extension'>.py</filename>
114 scripts into <filename class='directory'>/usr/bin</filename>.
115 So the byte code files for them will be installed into
116 <filename class='directory'>/usr/bin/__pycache__</filename>, which
117 is not allowed by FHS. Still as the &root; user, remove this
118 directory:
119 </para>
120
121 <screen role="root"><userinput>rm -rfv /usr/bin/__pycache__</userinput></screen> -->
122
123 <!-- Don't try pytest.
124 The test suite isn't compatible with pytest. -->
125 <para>
126 To test the installation, issue:
127 <command>test/alltests.py</command>.
128 </para>
129 </sect3>
130
131 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
132 href="../../../xincludes/pip3-cmd-explain.xml"/>
133
134 <sect3 role="content">
135 <title>Contents</title>
136
137 <segmentedlist>
138 <segtitle>Installed Programs</segtitle>
139 <segtitle>Installed Libraries</segtitle>
140 <segtitle>Installed Directories</segtitle>
141
142 <seglistitem>
143 <seg>
144 docutils, rst2html4, rst2html5, rst2html, rst2latex, rst2man,
145 rst2odt_prepstyles, rst2odt, rst2pseudoxml, rst2s5,
146 rst2xetex, rst2xml, and rstpep2html
147 </seg>
148 <seg>
149 None
150 </seg>
151 <seg>
152 /usr/lib/python&python3-majorver;/site-packages/docutils{,-&docutils-version;.dist-info}
153 </seg>
154 </seglistitem>
155 </segmentedlist>
156
157 <variablelist>
158 <bridgehead renderas="sect5">Short Descriptions</bridgehead>
159 <?dbfo list-presentation="list"?>
160 <?dbhtml list-presentation="table"?>
161
162 <varlistentry id="docutils-prog">
163 <term><command>docutils</command></term>
164 <listitem>
165 <para>
166 converts documents into various formats
167 </para>
168 <indexterm zone="docutils docutils-prog">
169 <primary sortas="b-docutils-prog">docutils</primary>
170 </indexterm>
171 </listitem>
172 </varlistentry>
173
174 <varlistentry id="rst2html">
175 <term><command>rst2html</command></term>
176 <listitem>
177 <para>
178 generates (X)HTML documents from standalone reStructuredText
179 sources
180 </para>
181 <indexterm zone="docutils rst2html">
182 <primary sortas="b-rst2html">rst2html</primary>
183 </indexterm>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry id="rst2html4">
188 <term><command>rst2html4</command></term>
189 <listitem>
190 <para>
191 generates (X)HTML documents from standalone reStructuredText
192 sources
193 </para>
194 <indexterm zone="docutils rst2html4">
195 <primary sortas="b-rst2html4">rst2html4</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 <varlistentry id="rst2html5">
201 <term><command>rst2html5</command></term>
202 <listitem>
203 <para>
204 generates HTML5 documents from standalone reStructuredText
205 sources
206 </para>
207 <indexterm zone="docutils rst2html5">
208 <primary sortas="b-rst2html5">rst2html5</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="rst2latex">
214 <term><command>rst2latex</command></term>
215 <listitem>
216 <para>
217 generates LaTeX documents from standalone reStructuredText
218 sources
219 </para>
220 <indexterm zone="docutils rst2latex">
221 <primary sortas="b-rst2latex">rst2latex</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="rst2man">
227 <term><command>rst2man</command></term>
228 <listitem>
229 <para>
230 generates plain unix manual documents from standalone
231 reStructuredText sources
232 </para>
233 <indexterm zone="docutils rst2man">
234 <primary sortas="b-rst2man">rst2man</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry id="rst2odt">
240 <term><command>rst2odt</command></term>
241 <listitem>
242 <para>
243 generates OpenDocument/OpenOffice/ODF documents from standalone
244 reStructuredText sources
245 </para>
246 <indexterm zone="docutils rst2odt">
247 <primary sortas="b-rst2odt">rst2odt</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="rst2odt_prepstyles">
253 <term><command>rst2odt_prepstyles</command></term>
254 <listitem>
255 <para>
256 Fix a word-processor-generated styles.odt for odtwriter use
257 </para>
258 <indexterm zone="docutils rst2odt_prepstyles">
259 <primary sortas="b-rst2odt_prepstyles">rst2odt_prepstyles</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="rst2pseudoxml">
265 <term><command>rst2pseudoxml</command></term>
266 <listitem>
267 <para>
268 generates pseudo-XML from standalone reStructuredText sources
269 (for testing purposes)
270 </para>
271 <indexterm zone="docutils rst2pseudoxml">
272 <primary sortas="b-rst2pseudoxml">rst2pseudoxml</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="rst2s5">
278 <term><command>rst2s5</command></term>
279 <listitem>
280 <para>
281 generates S5 (X)HTML slideshow from standalone reStructuredText
282 sources
283 </para>
284 <indexterm zone="docutils rst2s5">
285 <primary sortas="b-rst2s5">rst2s5</primary>
286 </indexterm>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry id="rst2xetex">
291 <term><command>rst2xetex</command></term>
292 <listitem>
293 <para>
294 generates LaTeX documents from standalone reStructuredText
295 sources for compilation with the Unicode-aware TeX variants
296 XeLaTeX or LuaLaTeX
297 </para>
298 <indexterm zone="docutils rst2xetex">
299 <primary sortas="b-rst2xetex">rst2xetex</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="rst2xml">
305 <term><command>rst2xml</command></term>
306 <listitem>
307 <para>
308 generates Docutils-native XML from standalone reStructuredText
309 sources
310 </para>
311 <indexterm zone="docutils rst2xml">
312 <primary sortas="b-rst2xml">rst2xml</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="rstpep2html">
318 <term><command>rstpep2html</command></term>
319 <listitem>
320 <para>
321 generates (X)HTML from reStructuredText-format PEP files
322 </para>
323 <indexterm zone="docutils rstpep2html">
324 <primary sortas="b-rstpep2html">rstpep2html</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 </variablelist>
330
331 </sect3>
332
333 </sect2>
Note: See TracBrowser for help on using the repository browser.