source: general/prog/python-modules/docutils.xml@ 3a579120

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since 3a579120 was 44b3f440, checked in by Xi Ruoyao <xry111@…>, 10 months ago

treewide: Really remove commented out references to Python 2

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