1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 markdown-download-http "https://files.pythonhosted.org/packages/source/M/Markdown/markdown-&markdown-version;.tar.gz">
|
---|
8 | <!ENTITY markdown-download-ftp " ">
|
---|
9 | <!ENTITY markdown-md5sum "&markdown-md5sum;">
|
---|
10 | <!ENTITY markdown-size "348 KB">
|
---|
11 | <!ENTITY markdown-buildsize "4.1 MB (add 27 MB for tests)">
|
---|
12 | <!ENTITY markdown-time "less than 0.1 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect2 id="markdown" xreflabel="Markdown-&markdown-version;">
|
---|
16 |
|
---|
17 | <title>Markdown-&markdown-version;</title>
|
---|
18 |
|
---|
19 | <indexterm zone="markdown">
|
---|
20 | <primary sortas="a-Markdown">Markdown</primary>
|
---|
21 | </indexterm>
|
---|
22 |
|
---|
23 | <sect3 role="package">
|
---|
24 | <title>Introduction to Markdown Module</title>
|
---|
25 |
|
---|
26 | <para>
|
---|
27 | <application>Markdown</application> is a Python parser for
|
---|
28 | John Gruber's Markdown specification.
|
---|
29 | </para>
|
---|
30 |
|
---|
31 | &lfs122_checked;
|
---|
32 |
|
---|
33 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
34 | <itemizedlist spacing="compact">
|
---|
35 | <listitem>
|
---|
36 | <para>
|
---|
37 | Download (HTTP): <ulink url="&markdown-download-http;"/>
|
---|
38 | </para>
|
---|
39 | </listitem>
|
---|
40 | <listitem>
|
---|
41 | <para>
|
---|
42 | Download (FTP): <ulink url="&markdown-download-ftp;"/>
|
---|
43 | </para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download MD5 sum: &markdown-md5sum;
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download size: &markdown-size;
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Estimated disk space required: &markdown-buildsize;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Estimated build time: &markdown-time;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | </itemizedlist>
|
---|
66 |
|
---|
67 | <bridgehead renderas="sect4">Markdown Dependencies</bridgehead>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
70 | <para role="optional">
|
---|
71 | <xref linkend="pytest"/>,
|
---|
72 | <xref linkend="PyYAML"/>, and
|
---|
73 | <ulink url="https://pypi.org/project/coverage/">coverage</ulink>
|
---|
74 | </para>
|
---|
75 |
|
---|
76 |
|
---|
77 | </sect3>
|
---|
78 |
|
---|
79 | <sect3 role="installation">
|
---|
80 | <title>Installation of Markdown</title>
|
---|
81 |
|
---|
82 | <para> Build the module: </para>
|
---|
83 |
|
---|
84 | &build-wheel;
|
---|
85 |
|
---|
86 | <para>
|
---|
87 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
88 | </para>
|
---|
89 |
|
---|
90 | <screen role="root"><userinput>&install-wheel; Markdown</userinput></screen>
|
---|
91 |
|
---|
92 | <para>
|
---|
93 | Assuming <xref linkend="pytest"/> and <xref linkend='PyYAML'/> are
|
---|
94 | installed and the other optional dependency is not, the installation
|
---|
95 | can be tested with:
|
---|
96 | </para>
|
---|
97 |
|
---|
98 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
99 | source testenv/bin/activate &&
|
---|
100 | pip3 install coverage &&
|
---|
101 | python3 /usr/bin/pytest --ignore=tests/test_syntax/extensions/test_md_in_html.py<!-- no && because of a possible error -->
|
---|
102 | deactivate</userinput></screen>
|
---|
103 |
|
---|
104 | </sect3>
|
---|
105 |
|
---|
106 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
107 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
108 |
|
---|
109 | <sect3 role="content">
|
---|
110 | <title>Contents</title>
|
---|
111 |
|
---|
112 | <segmentedlist>
|
---|
113 | <segtitle>Installed Programs</segtitle>
|
---|
114 | <segtitle>Installed Libraries</segtitle>
|
---|
115 | <segtitle>Installed Directories</segtitle>
|
---|
116 |
|
---|
117 | <seglistitem>
|
---|
118 | <seg>markdown_py</seg>
|
---|
119 | <seg>None</seg>
|
---|
120 | <seg>
|
---|
121 | /usr/lib/python&python3-majorver;/site-packages/markdown and
|
---|
122 | /usr/lib/python&python3-majorver;/site-packages/Markdown-&markdown-version;.dist-info
|
---|
123 | </seg>
|
---|
124 | </seglistitem>
|
---|
125 | </segmentedlist>
|
---|
126 |
|
---|
127 | <variablelist>
|
---|
128 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
129 | <?dbfo list-presentation="list"?>
|
---|
130 | <?dbhtml list-presentation="table"?>
|
---|
131 |
|
---|
132 | <varlistentry id="markdown_py">
|
---|
133 | <term><command>markdown_py</command></term>
|
---|
134 | <listitem>
|
---|
135 | <para>
|
---|
136 | converts markdown files to (x)html
|
---|
137 | </para>
|
---|
138 | <indexterm zone="markdown markdown_py">
|
---|
139 | <primary sortas="b-markdown_py">markdown_py</primary>
|
---|
140 | </indexterm>
|
---|
141 | </listitem>
|
---|
142 | </varlistentry>
|
---|
143 |
|
---|
144 | </variablelist>
|
---|
145 |
|
---|
146 | </sect3>
|
---|
147 |
|
---|
148 | </sect2>
|
---|