glfs/general/prog/python-modules/recommonmark.xml

<?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 recommonmark-download-http "https://files.pythonhosted.org/packages/source/r/recommonmark/recommonmark-&recommonmark-version;.tar.gz">
  <!ENTITY recommonmark-download-ftp  " ">
  <!ENTITY recommonmark-md5sum        "3c550a76eb62006bf007843a9f1805bb">
  <!ENTITY recommonmark-size          "34 KB">
  <!ENTITY recommonmark-buildsize     "680 KB (with tests)">
  <!ENTITY recommonmark-time          "less than 0.1 SBU (with tests)">
]>

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

    <title>Recommonmark-&recommonmark-version;</title>

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

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

      <para>
        <application>Recommonmark</application> is a docutils-compatibility
        bridge to CommonMark. It allows writing CommonMark inside of Docutils
        and Sphinx projects. <application>Recommonmark</application> is now
        deprecated in favor of <application>MyST</application>. Unfortunately,
        <xref linkend="llvm"/> still depends on this module.
      </para>

      &lfs112_checked;

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="commonmark"/> and
        <xref linkend="sphinx"/>
      </para>

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


    </sect3>

    <sect3 role="installation">
      <title>Installation of Recommonmark</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 recommonmark</userinput></screen>

    <para>
      <application>Recommonmark</application> is now deprecated in favor of
      <application>MyST</application>. For this reason, a lot of tests
      have to be disabled because they do not pass with recent versions of
      <application>Sphinx</application>. The installation can be partially
      tested with the following command:
    </para>

    <screen remap="test"><userinput>pytest -k 'not (test_integration or test_code or test_headings or test_image or test_links or test_lists)'</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>
            cm2html, cm2latex, cm2man, cm2pseudoxml, cm2xetex, and cm2xml
          </seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/recommonmark and
            /usr/lib/python&python3-majorver;/site-packages/recommonmark-&recommonmark-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="cm2html">
          <term><command>cm2html</command></term>
          <listitem>
            <para>
              generates a html document from markdown sources
            </para>
            <indexterm zone="recommonmark cm2html">
              <primary sortas="b-cm2html">cm2html</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="cm2latex">
          <term><command>cm2latex</command></term>
          <listitem>
            <para>
              generates a latex document from markdown sources
            </para>
            <indexterm zone="recommonmark cm2latex">
              <primary sortas="b-cm2latex">cm2latex</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="cm2man">
          <term><command>cm2man</command></term>
          <listitem>
            <para>
              generates a manpage from markdown sources
            </para>
            <indexterm zone="recommonmark cm2man">
              <primary sortas="b-cm2man">cm2man</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="cm2pseudoxml">
          <term><command>cm2pseudoxml</command></term>
          <listitem>
            <para>
              generates a pseudo-XML document from markdown sources
            </para>
            <indexterm zone="recommonmark cm2pseudoxml">
              <primary sortas="b-cm2pseudoxml">cm2pseudoxml</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="cm2xetex">
          <term><command>cm2xetex</command></term>
          <listitem>
            <para>
              generates a xetex document from markdown sources
            </para>
            <indexterm zone="recommonmark cm2xetex">
              <primary sortas="b-cm2xetex">cm2xetex</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="cm2xml">
          <term><command>cm2xml</command></term>
          <listitem>
            <para>
              generates an XML document from markdown sources
            </para>
            <indexterm zone="recommonmark cm2xml">
              <primary sortas="b-cm2xml">cm2xml</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>