[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[a8b202a] | 2 | <!DOCTYPE sect2 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 |
|
---|
| 7 | <!ENTITY recommonmark-download-http "https://files.pythonhosted.org/packages/source/r/recommonmark/recommonmark-&recommonmark-version;.tar.gz">
|
---|
| 8 | <!ENTITY recommonmark-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY recommonmark-md5sum "&recommonmark-md5sum;">
|
---|
[a8b202a] | 10 | <!ENTITY recommonmark-size "34 KB">
|
---|
[72c62e4] | 11 | <!ENTITY recommonmark-buildsize "680 KB (with tests)">
|
---|
| 12 | <!ENTITY recommonmark-time "less than 0.1 SBU (with tests)">
|
---|
[a8b202a] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="recommonmark" xreflabel="recommonmark-&recommonmark-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Recommonmark-&recommonmark-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="recommonmark">
|
---|
| 20 | <primary sortas="a-recommonmark">recommonmark</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Recommonmark Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | <application>Recommonmark</application> is a docutils-compatibility
|
---|
| 28 | bridge to CommonMark. It allows writing CommonMark inside of Docutils
|
---|
| 29 | and Sphinx projects. <application>Recommonmark</application> is now
|
---|
[e1dc8db] | 30 | deprecated in favor of
|
---|
| 31 | <ulink url="https://pypi.org/project/myst-parser/">MyST-Parser</ulink>.
|
---|
| 32 | Unfortunately, <xref linkend="llvm"/> still depends on this module.
|
---|
[a8b202a] | 33 | </para>
|
---|
| 34 |
|
---|
[f822342] | 35 | &lfs122_checked;
|
---|
[a8b202a] | 36 |
|
---|
| 37 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&recommonmark-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&recommonmark-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &recommonmark-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &recommonmark-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &recommonmark-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &recommonmark-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Recommonmark Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
| 75 | <xref linkend="commonmark"/> and
|
---|
| 76 | <xref linkend="sphinx"/>
|
---|
| 77 | </para>
|
---|
| 78 |
|
---|
| 79 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 80 | <para role="optional">
|
---|
| 81 | <xref linkend="pytest"/>
|
---|
| 82 | </para>
|
---|
| 83 |
|
---|
| 84 |
|
---|
| 85 | </sect3>
|
---|
| 86 |
|
---|
| 87 | <sect3 role="installation">
|
---|
| 88 | <title>Installation of Recommonmark</title>
|
---|
| 89 |
|
---|
| 90 | <para> Build the module: </para>
|
---|
| 91 |
|
---|
[db244ae2] | 92 | &build-wheel;
|
---|
[a8b202a] | 93 |
|
---|
| 94 | <para>
|
---|
| 95 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
[db244ae2] | 98 | <screen role="root"><userinput>&install-wheel; recommonmark</userinput></screen>
|
---|
[a8b202a] | 99 |
|
---|
| 100 | <para>
|
---|
| 101 | <application>Recommonmark</application> is now deprecated in favor of
|
---|
[e1dc8db] | 102 | <ulink url="https://pypi.org/project/myst-parser/">MyST-Parser</ulink>.
|
---|
| 103 | For this reason, a lot of tests
|
---|
[be11214] | 104 | have to be disabled because they do not pass with recent versions of
|
---|
[a8b202a] | 105 | <application>Sphinx</application>. The installation can be partially
|
---|
| 106 | tested with the following command:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
| 109 | <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>
|
---|
| 110 |
|
---|
| 111 | </sect3>
|
---|
| 112 |
|
---|
| 113 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 114 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 115 |
|
---|
| 116 | <sect3 role="content">
|
---|
| 117 | <title>Contents</title>
|
---|
| 118 |
|
---|
| 119 | <segmentedlist>
|
---|
| 120 | <segtitle>Installed Programs</segtitle>
|
---|
| 121 | <segtitle>Installed Libraries</segtitle>
|
---|
| 122 | <segtitle>Installed Directories</segtitle>
|
---|
| 123 |
|
---|
| 124 | <seglistitem>
|
---|
| 125 | <seg>
|
---|
| 126 | cm2html, cm2latex, cm2man, cm2pseudoxml, cm2xetex, and cm2xml
|
---|
| 127 | </seg>
|
---|
| 128 | <seg>None</seg>
|
---|
| 129 | <seg>
|
---|
| 130 | /usr/lib/python&python3-majorver;/site-packages/recommonmark and
|
---|
| 131 | /usr/lib/python&python3-majorver;/site-packages/recommonmark-&recommonmark-version;.dist-info
|
---|
| 132 | </seg>
|
---|
| 133 | </seglistitem>
|
---|
| 134 | </segmentedlist>
|
---|
| 135 |
|
---|
| 136 | <variablelist>
|
---|
| 137 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 138 | <?dbfo list-presentation="list"?>
|
---|
| 139 | <?dbhtml list-presentation="table"?>
|
---|
| 140 |
|
---|
| 141 | <varlistentry id="cm2html">
|
---|
| 142 | <term><command>cm2html</command></term>
|
---|
| 143 | <listitem>
|
---|
| 144 | <para>
|
---|
| 145 | generates a html document from markdown sources
|
---|
| 146 | </para>
|
---|
| 147 | <indexterm zone="recommonmark cm2html">
|
---|
| 148 | <primary sortas="b-cm2html">cm2html</primary>
|
---|
| 149 | </indexterm>
|
---|
| 150 | </listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 |
|
---|
| 153 | <varlistentry id="cm2latex">
|
---|
| 154 | <term><command>cm2latex</command></term>
|
---|
| 155 | <listitem>
|
---|
| 156 | <para>
|
---|
| 157 | generates a latex document from markdown sources
|
---|
| 158 | </para>
|
---|
| 159 | <indexterm zone="recommonmark cm2latex">
|
---|
| 160 | <primary sortas="b-cm2latex">cm2latex</primary>
|
---|
| 161 | </indexterm>
|
---|
| 162 | </listitem>
|
---|
| 163 | </varlistentry>
|
---|
| 164 |
|
---|
| 165 | <varlistentry id="cm2man">
|
---|
| 166 | <term><command>cm2man</command></term>
|
---|
| 167 | <listitem>
|
---|
| 168 | <para>
|
---|
| 169 | generates a manpage from markdown sources
|
---|
| 170 | </para>
|
---|
| 171 | <indexterm zone="recommonmark cm2man">
|
---|
| 172 | <primary sortas="b-cm2man">cm2man</primary>
|
---|
| 173 | </indexterm>
|
---|
| 174 | </listitem>
|
---|
| 175 | </varlistentry>
|
---|
| 176 |
|
---|
| 177 | <varlistentry id="cm2pseudoxml">
|
---|
| 178 | <term><command>cm2pseudoxml</command></term>
|
---|
| 179 | <listitem>
|
---|
| 180 | <para>
|
---|
| 181 | generates a pseudo-XML document from markdown sources
|
---|
| 182 | </para>
|
---|
| 183 | <indexterm zone="recommonmark cm2pseudoxml">
|
---|
| 184 | <primary sortas="b-cm2pseudoxml">cm2pseudoxml</primary>
|
---|
| 185 | </indexterm>
|
---|
| 186 | </listitem>
|
---|
| 187 | </varlistentry>
|
---|
| 188 |
|
---|
| 189 | <varlistentry id="cm2xetex">
|
---|
| 190 | <term><command>cm2xetex</command></term>
|
---|
| 191 | <listitem>
|
---|
| 192 | <para>
|
---|
| 193 | generates a xetex document from markdown sources
|
---|
| 194 | </para>
|
---|
| 195 | <indexterm zone="recommonmark cm2xetex">
|
---|
| 196 | <primary sortas="b-cm2xetex">cm2xetex</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
| 201 | <varlistentry id="cm2xml">
|
---|
| 202 | <term><command>cm2xml</command></term>
|
---|
| 203 | <listitem>
|
---|
| 204 | <para>
|
---|
| 205 | generates an XML document from markdown sources
|
---|
| 206 | </para>
|
---|
| 207 | <indexterm zone="recommonmark cm2xml">
|
---|
| 208 | <primary sortas="b-cm2xml">cm2xml</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | </variablelist>
|
---|
| 214 |
|
---|
| 215 | </sect3>
|
---|
| 216 |
|
---|
| 217 | </sect2>
|
---|