source: general/prog/python-modules/docutils.xml@ 179b34e

12.1 ken/TL2024 lazarus trunk xry111/llvm18
Last change on this file since 179b34e was ab4fdfc, checked in by Pierre Labastie <pierre.labastie@…>, 4 months ago

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