1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
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 "93bcfe0065cf1d0b6a0bcabeca7a2335">
|
---|
10 | <!ENTITY docutils-size "2.0 MB">
|
---|
11 | <!ENTITY docutils-buildsize "12 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 | &lfs120_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 | <!--
|
---|
70 | <bridgehead renderas="sect4">Docutils Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
73 | <para role="optional">
|
---|
74 | <xref linkend="python2"/>
|
---|
75 | </para>
|
---|
76 | -->
|
---|
77 |
|
---|
78 | <para condition="html" role="usernotes">
|
---|
79 | Editor Notes: <ulink url="&blfs-wiki;/docutils"/>
|
---|
80 | </para>
|
---|
81 | </sect3>
|
---|
82 |
|
---|
83 | <sect3 role="installation">
|
---|
84 | <title>Installation of docutils</title>
|
---|
85 |
|
---|
86 | <!-- Editors note: Use - -root= instead of DESTDIR= when updating. -->
|
---|
87 |
|
---|
88 | <para>
|
---|
89 | To build the <application>Python 3</application> applications,
|
---|
90 | run the following command:
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
94 |
|
---|
95 | <para>
|
---|
96 | To install the <application>Python</application> applications
|
---|
97 | run the following as the &root; user:
|
---|
98 | </para>
|
---|
99 |
|
---|
100 | <screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user docutils &&
|
---|
101 |
|
---|
102 | for f in /usr/bin/rst*.py; do
|
---|
103 | ln -svf $(basename $f) /usr/bin/$(basename $f .py)
|
---|
104 | done</userinput></screen>
|
---|
105 |
|
---|
106 | <!-- FHS 3.0 section 4.4.2:
|
---|
107 | "There must be no subdirectories in /usr/bin."
|
---|
108 | But pip maintainers closed this as WONTFIX:
|
---|
109 | https://github.com/pypa/pip/issues/6906 -->
|
---|
110 | <para>
|
---|
111 | To reduce the time needed for loading Python scripts,
|
---|
112 | <command>pip3 install</command> will compile the scripts with
|
---|
113 | extension <filename class='extension'>.py</filename> into byte code
|
---|
114 | and save the result into
|
---|
115 | <filename class='extension'>.pyc</filename> files in the directory
|
---|
116 | <filename class='directory'>__pycache__</filename>.
|
---|
117 | But this package installs <filename class='extension'>.py</filename>
|
---|
118 | scripts into <filename class='directory'>/usr/bin</filename>.
|
---|
119 | So the byte code files for them will be installed into
|
---|
120 | <filename class='directory'>/usr/bin/__pycache__</filename>, which
|
---|
121 | is not allowed by FHS. Still as the &root; user, remove this
|
---|
122 | directory:
|
---|
123 | </para>
|
---|
124 |
|
---|
125 | <screen role="root"><userinput>rm -rfv /usr/bin/__pycache__</userinput></screen>
|
---|
126 | </sect3>
|
---|
127 |
|
---|
128 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
129 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
130 |
|
---|
131 | <sect3 role="content">
|
---|
132 | <title>Contents</title>
|
---|
133 |
|
---|
134 | <segmentedlist>
|
---|
135 | <segtitle>Installed Programs</segtitle>
|
---|
136 | <segtitle>Installed Libraries</segtitle>
|
---|
137 | <segtitle>Installed Directories</segtitle>
|
---|
138 |
|
---|
139 | <seglistitem>
|
---|
140 | <seg>
|
---|
141 | docutils, rst2html4, rst2html5, rst2html, rst2latex, rst2man,
|
---|
142 | rst2odt_prepstyles, rst2odt, rst2pseudoxml, rst2s5,
|
---|
143 | rst2xetex, rst2xml, and rstpep2html
|
---|
144 | </seg>
|
---|
145 | <seg>
|
---|
146 | None
|
---|
147 | </seg>
|
---|
148 | <seg>
|
---|
149 | /usr/lib/python&python3-majorver;/site-packages/docutils{,-&docutils-version;.dist-info}
|
---|
150 | </seg>
|
---|
151 | </seglistitem>
|
---|
152 | </segmentedlist>
|
---|
153 |
|
---|
154 | <variablelist>
|
---|
155 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
156 | <?dbfo list-presentation="list"?>
|
---|
157 | <?dbhtml list-presentation="table"?>
|
---|
158 |
|
---|
159 | <varlistentry id="docutils-prog">
|
---|
160 | <term><command>docutils</command></term>
|
---|
161 | <listitem>
|
---|
162 | <para>
|
---|
163 | converts documents into various formats
|
---|
164 | </para>
|
---|
165 | <indexterm zone="docutils docutils-prog">
|
---|
166 | <primary sortas="b-docutils-prog">docutils</primary>
|
---|
167 | </indexterm>
|
---|
168 | </listitem>
|
---|
169 | </varlistentry>
|
---|
170 |
|
---|
171 | <varlistentry id="rst2html">
|
---|
172 | <term><command>rst2html</command></term>
|
---|
173 | <listitem>
|
---|
174 | <para>
|
---|
175 | generates (X)HTML documents from standalone reStructuredText
|
---|
176 | sources
|
---|
177 | </para>
|
---|
178 | <indexterm zone="docutils rst2html">
|
---|
179 | <primary sortas="b-rst2html">rst2html</primary>
|
---|
180 | </indexterm>
|
---|
181 | </listitem>
|
---|
182 | </varlistentry>
|
---|
183 |
|
---|
184 | <varlistentry id="rst2html4">
|
---|
185 | <term><command>rst2html4</command></term>
|
---|
186 | <listitem>
|
---|
187 | <para>
|
---|
188 | generates (X)HTML documents from standalone reStructuredText
|
---|
189 | sources
|
---|
190 | </para>
|
---|
191 | <indexterm zone="docutils rst2html4">
|
---|
192 | <primary sortas="b-rst2html4">rst2html4</primary>
|
---|
193 | </indexterm>
|
---|
194 | </listitem>
|
---|
195 | </varlistentry>
|
---|
196 |
|
---|
197 | <varlistentry id="rst2html5">
|
---|
198 | <term><command>rst2html5</command></term>
|
---|
199 | <listitem>
|
---|
200 | <para>
|
---|
201 | generates HTML5 documents from standalone reStructuredText
|
---|
202 | sources
|
---|
203 | </para>
|
---|
204 | <indexterm zone="docutils rst2html5">
|
---|
205 | <primary sortas="b-rst2html5">rst2html5</primary>
|
---|
206 | </indexterm>
|
---|
207 | </listitem>
|
---|
208 | </varlistentry>
|
---|
209 |
|
---|
210 | <varlistentry id="rst2latex">
|
---|
211 | <term><command>rst2latex</command></term>
|
---|
212 | <listitem>
|
---|
213 | <para>
|
---|
214 | generates LaTeX documents from standalone reStructuredText
|
---|
215 | sources
|
---|
216 | </para>
|
---|
217 | <indexterm zone="docutils rst2latex">
|
---|
218 | <primary sortas="b-rst2latex">rst2latex</primary>
|
---|
219 | </indexterm>
|
---|
220 | </listitem>
|
---|
221 | </varlistentry>
|
---|
222 |
|
---|
223 | <varlistentry id="rst2man">
|
---|
224 | <term><command>rst2man</command></term>
|
---|
225 | <listitem>
|
---|
226 | <para>
|
---|
227 | generates plain unix manual documents from standalone
|
---|
228 | reStructuredText sources
|
---|
229 | </para>
|
---|
230 | <indexterm zone="docutils rst2man">
|
---|
231 | <primary sortas="b-rst2man">rst2man</primary>
|
---|
232 | </indexterm>
|
---|
233 | </listitem>
|
---|
234 | </varlistentry>
|
---|
235 |
|
---|
236 | <varlistentry id="rst2odt">
|
---|
237 | <term><command>rst2odt</command></term>
|
---|
238 | <listitem>
|
---|
239 | <para>
|
---|
240 | generates OpenDocument/OpenOffice/ODF documents from standalone
|
---|
241 | reStructuredText sources
|
---|
242 | </para>
|
---|
243 | <indexterm zone="docutils rst2odt">
|
---|
244 | <primary sortas="b-rst2odt">rst2odt</primary>
|
---|
245 | </indexterm>
|
---|
246 | </listitem>
|
---|
247 | </varlistentry>
|
---|
248 |
|
---|
249 | <varlistentry id="rst2odt_prepstyles">
|
---|
250 | <term><command>rst2odt_prepstyles</command></term>
|
---|
251 | <listitem>
|
---|
252 | <para>
|
---|
253 | Fix a word-processor-generated styles.odt for odtwriter use
|
---|
254 | </para>
|
---|
255 | <indexterm zone="docutils rst2odt_prepstyles">
|
---|
256 | <primary sortas="b-rst2odt_prepstyles">rst2odt_prepstyles</primary>
|
---|
257 | </indexterm>
|
---|
258 | </listitem>
|
---|
259 | </varlistentry>
|
---|
260 |
|
---|
261 | <varlistentry id="rst2pseudoxml">
|
---|
262 | <term><command>rst2pseudoxml</command></term>
|
---|
263 | <listitem>
|
---|
264 | <para>
|
---|
265 | generates pseudo-XML from standalone reStructuredText sources
|
---|
266 | (for testing purposes)
|
---|
267 | </para>
|
---|
268 | <indexterm zone="docutils rst2pseudoxml">
|
---|
269 | <primary sortas="b-rst2pseudoxml">rst2pseudoxml</primary>
|
---|
270 | </indexterm>
|
---|
271 | </listitem>
|
---|
272 | </varlistentry>
|
---|
273 |
|
---|
274 | <varlistentry id="rst2s5">
|
---|
275 | <term><command>rst2s5</command></term>
|
---|
276 | <listitem>
|
---|
277 | <para>
|
---|
278 | generates S5 (X)HTML slideshow from standalone reStructuredText
|
---|
279 | sources
|
---|
280 | </para>
|
---|
281 | <indexterm zone="docutils rst2s5">
|
---|
282 | <primary sortas="b-rst2s5">rst2s5</primary>
|
---|
283 | </indexterm>
|
---|
284 | </listitem>
|
---|
285 | </varlistentry>
|
---|
286 |
|
---|
287 | <varlistentry id="rst2xetex">
|
---|
288 | <term><command>rst2xetex</command></term>
|
---|
289 | <listitem>
|
---|
290 | <para>
|
---|
291 | generates LaTeX documents from standalone reStructuredText
|
---|
292 | sources for compilation with the Unicode-aware TeX variants
|
---|
293 | XeLaTeX or LuaLaTeX
|
---|
294 | </para>
|
---|
295 | <indexterm zone="docutils rst2xetex">
|
---|
296 | <primary sortas="b-rst2xetex">rst2xetex</primary>
|
---|
297 | </indexterm>
|
---|
298 | </listitem>
|
---|
299 | </varlistentry>
|
---|
300 |
|
---|
301 | <varlistentry id="rst2xml">
|
---|
302 | <term><command>rst2xml</command></term>
|
---|
303 | <listitem>
|
---|
304 | <para>
|
---|
305 | generates Docutils-native XML from standalone reStructuredText
|
---|
306 | sources
|
---|
307 | </para>
|
---|
308 | <indexterm zone="docutils rst2xml">
|
---|
309 | <primary sortas="b-rst2xml">rst2xml</primary>
|
---|
310 | </indexterm>
|
---|
311 | </listitem>
|
---|
312 | </varlistentry>
|
---|
313 |
|
---|
314 | <varlistentry id="rstpep2html">
|
---|
315 | <term><command>rstpep2html</command></term>
|
---|
316 | <listitem>
|
---|
317 | <para>
|
---|
318 | generates (X)HTML from reStructuredText-format PEP files
|
---|
319 | </para>
|
---|
320 | <indexterm zone="docutils rstpep2html">
|
---|
321 | <primary sortas="b-rstpep2html">rstpep2html</primary>
|
---|
322 | </indexterm>
|
---|
323 | </listitem>
|
---|
324 | </varlistentry>
|
---|
325 |
|
---|
326 | </variablelist>
|
---|
327 |
|
---|
328 | </sect3>
|
---|
329 |
|
---|
330 | </sect2>
|
---|