source: general/prog/python-modules/docutils.xml@ 5fe69261

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   <!ENTITY % general-entities SYSTEM "../../../general.ent">
  %general-entities;

  <!ENTITY docutils-download-http "https://downloads.sourceforge.net/docutils/docutils-&docutils-version;.tar.gz">
  <!ENTITY docutils-download-ftp  " ">
  <!ENTITY docutils-md5sum        "0afa992a6e93db892107c3f087d0d9df">
  <!ENTITY docutils-size          "2.0 MB">
  <!ENTITY docutils-buildsize     "12 MB">
  <!ENTITY docutils-time          "less than 0.1 SBU">
]>

  <!-- Begin docutils -->
  <sect2 id="docutils" xreflabel="docutils-&docutils-version;">

    <title>docutils-&docutils-version;</title>

    <indexterm zone="docutils">
      <primary sortas="a-docutils">docutils</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to docutils</title>

      <para>
        <application>docutils</application> is a set of
        <application>Python</application> modules and programs
        for processing plaintext docs into formats such as HTML, XML, or LaTeX.
      </para>

      &lfs112_checked;

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&docutils-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download (FTP): <ulink url="&docutils-download-ftp;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &docutils-md5sum;
          </para>
        </listitem>
        <listitem>
          <para>
            Download size: &docutils-size;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated disk space required: &docutils-buildsize;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated build time: &docutils-time;
          </para>
        </listitem>
      </itemizedlist>

<!--
      <bridgehead renderas="sect4">Docutils Dependencies</bridgehead>

      <bridgehead renderas="sect5">Optional</bridgehead>
      <para role="optional">
        <xref linkend="python2"/>
      </para>
-->

      <para condition="html" role="usernotes">
        User Notes: <ulink url="&blfs-wiki;/docutils"/>
      </para>
    </sect3>

    <sect3 role="installation">
      <title>Installation of docutils</title>

<!-- Editors note: Use - -root= instead of DESTDIR= when updating. -->

      <para>
        To build the <application>Python 3</application> applications,
        run the following command:
      </para>

<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>

      <para>
        To install the <application>Python</application> applications
        run the following as the &root; user:
      </para>

<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user docutils &amp;&amp;

for f in /usr/bin/rst*.py; do
  ln -svf $(basename $f) /usr/bin/$(basename $f .py)
done</userinput></screen>

      <!-- FHS 3.0 section 4.4.2:
           "There must be no subdirectories in /usr/bin."
           But pip maintainers closed this as WONTFIX:
           https://github.com/pypa/pip/issues/6906 -->
      <para>
        To reduce the time needed for loading Python scripts,
        <command>pip3 install</command> will compile the scripts with
        extension <filename class='extension'>.py</filename> into byte code
        and save the result into
        <filename class='extension'>.pyc</filename> files in the directory
        <filename class='directory'>__pycache__</filename>.
        But this package installs <filename class='extension'>.py</filename>
        scripts into <filename class='directory'>/usr/bin</filename>.
        So the byte code files for them will be installed into
        <filename class='directory'>/usr/bin/__pycache__</filename>, which
        is not allowed by FHS.  Still as the &root; user, remove this
        directory:
      </para>

<screen role="root"><userinput>rm -rfv /usr/bin/__pycache__</userinput></screen>
    </sect3>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../../xincludes/pip3-cmd-explain.xml"/>

    <sect3 role="content">
      <title>Contents</title>

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Libraries</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>
            rst2html4, rst2html5, rst2html, rst2latex, rst2man,
            rst2odt_prepstyles, rst2odt, rst2pseudoxml, rst2s5,
            rst2xetex, rst2xml, and rstpep2html
          </seg>
          <seg>
            None
          </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/docutils{,-&docutils-version;.dist-info}
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>