source: general/prog/python-dependencies/markdown.xml@ 15445ab

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 markdown-download-http "https://files.pythonhosted.org/packages/source/M/Markdown/Markdown-&markdown-version;.tar.gz">
  <!ENTITY markdown-download-ftp  " ">
  <!ENTITY markdown-md5sum        "&markdown-md5sum;">
  <!ENTITY markdown-size          "315 KB">
  <!ENTITY markdown-buildsize     "4.1 MB (add 27 MB for tests)">
  <!ENTITY markdown-time          "less than 0.1 SBU (with tests)">
]>

  <sect2 id="markdown" xreflabel="Markdown-&markdown-version;">

    <title>Markdown-&markdown-version;</title>

    <indexterm zone="markdown">
      <primary sortas="a-Markdown">Markdown</primary>
    </indexterm>

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

      <para>
        <application>Markdown</application> is a Python parser for
        John Gruber's Markdown specification.
      </para>

      &lfs113_checked;

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

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

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/>,
        <xref linkend="PyYAML"/>, and
        <ulink url="https://pypi.org/project/coverage/">coverage</ulink>
      </para>


    </sect3>

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

    <para> Build the module: </para>

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

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

<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user Markdown</userinput></screen>

    <para>
      Assuming <xref linkend="pytest"/> and <xref linkend="PyYAML"/> are
      installed and the other optional dependency is not, the installation
      can be tested with:
    </para>

<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &amp;&amp;
source testenv/bin/activate                    &amp;&amp;
pip3 install coverage                          &amp;&amp;
python3 /usr/bin/pytest --ignore=tests/test_syntax/extensions/test_md_in_html.py<!-- no && because of a possible error -->
deactivate</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>markdown_py</seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/markdown and
            /usr/lib/python&python3-majorver;/site-packages/Markdown-&markdown-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="markdown_py">
          <term><command>markdown_py</command></term>
          <listitem>
            <para>
              converts markdown files to (x)html
            </para>
            <indexterm zone="markdown markdown_py">
              <primary sortas="b-markdown_py">markdown_py</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>