source: general/prog/python-modules/docutils.xml

trunk
Last change on this file was ebf7647, checked in by Bruce Dubbs <bdubbs@…>, 8 days ago

Update to docutils-0.21.1 (Python module).
  • Property mode set to 100644
File size: 10.5 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 "5cdc4aee7a8a11fb0d5ce8039a37c809">
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 <para>
104 To reduce the time needed for loading Python scripts,
105 <command>pip3 install</command> will compile the scripts with
106 extension <filename class='extension'>.py</filename> into byte code
107 and save the result into
108 <filename class='extension'>.pyc</filename> files in the directory
109 <filename class='directory'>__pycache__</filename>.
110 But this package installs <filename class='extension'>.py</filename>
111 scripts into <filename class='directory'>/usr/bin</filename>.
112 So the byte code files for them will be installed into
113 <filename class='directory'>/usr/bin/__pycache__</filename>, which
114 is not allowed by FHS. Still as the &root; user, remove this
115 directory:
116 </para>
117
118<screen role="root"><userinput>rm -rfv /usr/bin/__pycache__</userinput></screen>
119 </sect3>
120
121 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
122 href="../../../xincludes/pip3-cmd-explain.xml"/>
123
124 <sect3 role="content">
125 <title>Contents</title>
126
127 <segmentedlist>
128 <segtitle>Installed Programs</segtitle>
129 <segtitle>Installed Libraries</segtitle>
130 <segtitle>Installed Directories</segtitle>
131
132 <seglistitem>
133 <seg>
134 docutils, rst2html4, rst2html5, rst2html, rst2latex, rst2man,
135 rst2odt_prepstyles, rst2odt, rst2pseudoxml, rst2s5,
136 rst2xetex, rst2xml, and rstpep2html
137 </seg>
138 <seg>
139 None
140 </seg>
141 <seg>
142 /usr/lib/python&python3-majorver;/site-packages/docutils{,-&docutils-version;.dist-info}
143 </seg>
144 </seglistitem>
145 </segmentedlist>
146
147 <variablelist>
148 <bridgehead renderas="sect5">Short Descriptions</bridgehead>
149 <?dbfo list-presentation="list"?>
150 <?dbhtml list-presentation="table"?>
151
152 <varlistentry id="docutils-prog">
153 <term><command>docutils</command></term>
154 <listitem>
155 <para>
156 converts documents into various formats
157 </para>
158 <indexterm zone="docutils docutils-prog">
159 <primary sortas="b-docutils-prog">docutils</primary>
160 </indexterm>
161 </listitem>
162 </varlistentry>
163
164 <varlistentry id="rst2html">
165 <term><command>rst2html</command></term>
166 <listitem>
167 <para>
168 generates (X)HTML documents from standalone reStructuredText
169 sources
170 </para>
171 <indexterm zone="docutils rst2html">
172 <primary sortas="b-rst2html">rst2html</primary>
173 </indexterm>
174 </listitem>
175 </varlistentry>
176
177 <varlistentry id="rst2html4">
178 <term><command>rst2html4</command></term>
179 <listitem>
180 <para>
181 generates (X)HTML documents from standalone reStructuredText
182 sources
183 </para>
184 <indexterm zone="docutils rst2html4">
185 <primary sortas="b-rst2html4">rst2html4</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189
190 <varlistentry id="rst2html5">
191 <term><command>rst2html5</command></term>
192 <listitem>
193 <para>
194 generates HTML5 documents from standalone reStructuredText
195 sources
196 </para>
197 <indexterm zone="docutils rst2html5">
198 <primary sortas="b-rst2html5">rst2html5</primary>
199 </indexterm>
200 </listitem>
201 </varlistentry>
202
203 <varlistentry id="rst2latex">
204 <term><command>rst2latex</command></term>
205 <listitem>
206 <para>
207 generates LaTeX documents from standalone reStructuredText
208 sources
209 </para>
210 <indexterm zone="docutils rst2latex">
211 <primary sortas="b-rst2latex">rst2latex</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 <varlistentry id="rst2man">
217 <term><command>rst2man</command></term>
218 <listitem>
219 <para>
220 generates plain unix manual documents from standalone
221 reStructuredText sources
222 </para>
223 <indexterm zone="docutils rst2man">
224 <primary sortas="b-rst2man">rst2man</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="rst2odt">
230 <term><command>rst2odt</command></term>
231 <listitem>
232 <para>
233 generates OpenDocument/OpenOffice/ODF documents from standalone
234 reStructuredText sources
235 </para>
236 <indexterm zone="docutils rst2odt">
237 <primary sortas="b-rst2odt">rst2odt</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="rst2odt_prepstyles">
243 <term><command>rst2odt_prepstyles</command></term>
244 <listitem>
245 <para>
246 Fix a word-processor-generated styles.odt for odtwriter use
247 </para>
248 <indexterm zone="docutils rst2odt_prepstyles">
249 <primary sortas="b-rst2odt_prepstyles">rst2odt_prepstyles</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="rst2pseudoxml">
255 <term><command>rst2pseudoxml</command></term>
256 <listitem>
257 <para>
258 generates pseudo-XML from standalone reStructuredText sources
259 (for testing purposes)
260 </para>
261 <indexterm zone="docutils rst2pseudoxml">
262 <primary sortas="b-rst2pseudoxml">rst2pseudoxml</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="rst2s5">
268 <term><command>rst2s5</command></term>
269 <listitem>
270 <para>
271 generates S5 (X)HTML slideshow from standalone reStructuredText
272 sources
273 </para>
274 <indexterm zone="docutils rst2s5">
275 <primary sortas="b-rst2s5">rst2s5</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="rst2xetex">
281 <term><command>rst2xetex</command></term>
282 <listitem>
283 <para>
284 generates LaTeX documents from standalone reStructuredText
285 sources for compilation with the Unicode-aware TeX variants
286 XeLaTeX or LuaLaTeX
287 </para>
288 <indexterm zone="docutils rst2xetex">
289 <primary sortas="b-rst2xetex">rst2xetex</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="rst2xml">
295 <term><command>rst2xml</command></term>
296 <listitem>
297 <para>
298 generates Docutils-native XML from standalone reStructuredText
299 sources
300 </para>
301 <indexterm zone="docutils rst2xml">
302 <primary sortas="b-rst2xml">rst2xml</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="rstpep2html">
308 <term><command>rstpep2html</command></term>
309 <listitem>
310 <para>
311 generates (X)HTML from reStructuredText-format PEP files
312 </para>
313 <indexterm zone="docutils rstpep2html">
314 <primary sortas="b-rstpep2html">rstpep2html</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 </variablelist>
320
321 </sect3>
322
323 </sect2>
Note: See TracBrowser for help on using the repository browser.