source: general/prog/python-dependencies/smartypants.xml@ 6f165db

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect2 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 smartypants-download-http "https://github.com/leohemsted/smartypants.py/archive/v&smartypants-version;/smartypants-&smartypants-version;.tar.gz">
  <!ENTITY smartypants-download-ftp  " ">
  <!ENTITY smartypants-md5sum        "27957540f4718e892039b2ed208c78f3">
  <!ENTITY smartypants-size          "24 KB">
  <!ENTITY smartypants-buildsize     "344 KB">
  <!ENTITY smartypants-time          "less than 0.1 SBU">
]>

  <sect2 id="smartypants" xreflabel="smartypants-&smartypants-version;">

    <title>Smartypants-&smartypants-version;</title>

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

    <sect3 role="package">
      <title>Introduction to Smartypants Module</title>

      <para>
        <application>Smartypants</application> translates plain ASCII
        punctuation characters into <quote>smart</quote> typographic
        punctuation HTML entities.
      </para>

      &lfs122_checked;

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

      <bridgehead renderas="sect4">Smartypants Dependencies</bridgehead>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="docutils"/>,
        <xref linkend="pygments"/>, and
        <xref linkend="pytest"/>
      </para>

    </sect3>

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

      <note>
        <para>
          The tarball extracts into the
          <filename class='directory'>smartypants.py-&smartypants-version;</filename>
          directory.
        </para>
      </note>

    <para>Build the module: </para>

&build-wheel;

    <para>
      This package does not come with a working test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

    <screen role="root"><userinput>&install-wheel; smartypants</userinput></screen>

    <para>
      To test the results, issue:
    </para>

    <screen remap="test"><userinput>sed 's/assertEquals/assertEqual/' -i tests/test_cli.py &amp;&amp;
cp /usr/bin/smartypants . &amp;&amp;
pytest</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>smartypants</seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/smartypants-&smartypants-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect3">Short Descriptions</bridgehead>
        <?dbfo list-presentation="list"?>
        <?dbhtml list-presentation="table"?>

        <varlistentry id="smartypants-prog">
          <term><command>smartypants</command></term>
          <listitem>
            <para>
              translates ASCII punctuation to HTML punctuation.
            </para>
            <indexterm zone="smartypants smartypants-prog">
              <primary sortas="b-smartypants-prog">smartypants</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>