[d3ea9e8] | 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 |
|
---|
[c6b192c] | 7 | <!ENTITY docutils-download-http "https://downloads.sourceforge.net/docutils/docutils-&docutils-version;.tar.gz">
|
---|
[d3ea9e8] | 8 | <!ENTITY docutils-download-ftp " ">
|
---|
[5431aad] | 9 | <!ENTITY docutils-md5sum "ca5827e2432fd58f4c8d74a6591135de">
|
---|
[91d3d08c] | 10 | <!ENTITY docutils-size "1.9 MB">
|
---|
[5431aad] | 11 | <!ENTITY docutils-buildsize "12 MB">
|
---|
[c4dc2c5] | 12 | <!ENTITY docutils-time "less than 0.1 SBU">
|
---|
[d3ea9e8] | 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>
|
---|
[8558044] | 28 | <application>docutils</application> is a set of
|
---|
[d3ea9e8] | 29 | <application>Python</application> modules and programs
|
---|
| 30 | for processing plaintext docs into formats such as HTML, XML, or LaTeX.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[03a2986] | 33 | &lfs111_checked;
|
---|
[d3ea9e8] | 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 |
|
---|
[4f35d45] | 69 | <!--
|
---|
[356a7a9] | 70 | <bridgehead renderas="sect4">Docutils Dependencies</bridgehead>
|
---|
| 71 |
|
---|
[f0190231] | 72 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
| 73 | <para role="optional">
|
---|
[356a7a9] | 74 | <xref linkend="python2"/>
|
---|
| 75 | </para>
|
---|
[4f35d45] | 76 | -->
|
---|
[356a7a9] | 77 |
|
---|
[d3ea9e8] | 78 | <para condition="html" role="usernotes">
|
---|
| 79 | User 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>
|
---|
[f0190231] | 89 | To build the <application>Python 3</application> applications,
|
---|
[d3ea9e8] | 90 | run the following command:
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
[d31adba2] | 93 | <screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
[d3ea9e8] | 94 |
|
---|
| 95 | <para>
|
---|
[356a7a9] | 96 | To install the <application>Python</application> applications
|
---|
[d31adba2] | 97 | run the following as the &root; user:
|
---|
[d3ea9e8] | 98 | </para>
|
---|
| 99 |
|
---|
[d31adba2] | 100 | <screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir docutils &&
|
---|
[d3ea9e8] | 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 |
|
---|
[79cb38e2] | 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>
|
---|
[d3ea9e8] | 126 | </sect3>
|
---|
| 127 |
|
---|
[d31adba2] | 128 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 129 | href="../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 130 |
|
---|
[d3ea9e8] | 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 | 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>
|
---|
[d31adba2] | 149 | /usr/lib/python&python3-majorver;/site-packages/docutils{,-&docutils-version;.dist-info}
|
---|
[d3ea9e8] | 150 | </seg>
|
---|
| 151 | </seglistitem>
|
---|
| 152 | </segmentedlist>
|
---|
| 153 |
|
---|
| 154 | </sect3>
|
---|
| 155 |
|
---|
| 156 | </sect2>
|
---|