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 smartypants-download-http "https://github.com/leohemsted/smartypants.py/archive/v&smartypants-version;/smartypants-&smartypants-version;.tar.gz">
|
---|
8 | <!ENTITY smartypants-download-ftp " ">
|
---|
9 | <!ENTITY smartypants-md5sum "27957540f4718e892039b2ed208c78f3">
|
---|
10 | <!ENTITY smartypants-size "24 KB">
|
---|
11 | <!ENTITY smartypants-buildsize "344 KB">
|
---|
12 | <!ENTITY smartypants-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect2 id="smartypants" xreflabel="smartypants-&smartypants-version;">
|
---|
16 |
|
---|
17 | <title>Smartypants-&smartypants-version;</title>
|
---|
18 |
|
---|
19 | <indexterm zone="smartypants">
|
---|
20 | <primary sortas="a-smartypants">smartypants</primary>
|
---|
21 | </indexterm>
|
---|
22 |
|
---|
23 | <sect3 role="package">
|
---|
24 | <title>Introduction to Smartypants Module</title>
|
---|
25 |
|
---|
26 | <para>
|
---|
27 | <application>Smartypants</application> translates plain ASCII
|
---|
28 | punctuation characters into <quote>smart</quote> typographic
|
---|
29 | punctuation HTML entities.
|
---|
30 | </para>
|
---|
31 |
|
---|
32 | &lfs122_checked;
|
---|
33 |
|
---|
34 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
35 | <itemizedlist spacing="compact">
|
---|
36 | <listitem>
|
---|
37 | <para>
|
---|
38 | Download (HTTP): <ulink url="&smartypants-download-http;"/>
|
---|
39 | </para>
|
---|
40 | </listitem>
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (FTP): <ulink url="&smartypants-download-ftp;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download MD5 sum: &smartypants-md5sum;
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download size: &smartypants-size;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Estimated disk space required: &smartypants-buildsize;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated build time: &smartypants-time;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | </itemizedlist>
|
---|
67 |
|
---|
68 | <bridgehead renderas="sect4">Smartypants Dependencies</bridgehead>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
71 | <para role="optional">
|
---|
72 | <xref linkend="docutils"/>,
|
---|
73 | <xref linkend="pygments"/>, and
|
---|
74 | <xref linkend="pytest"/>
|
---|
75 | </para>
|
---|
76 |
|
---|
77 | </sect3>
|
---|
78 |
|
---|
79 | <sect3 role="installation">
|
---|
80 | <title>Installation of Smartypants</title>
|
---|
81 |
|
---|
82 | <note>
|
---|
83 | <para>
|
---|
84 | The tarball extracts into the
|
---|
85 | <filename class='directory'>smartypants.py-&smartypants-version;</filename>
|
---|
86 | directory.
|
---|
87 | </para>
|
---|
88 | </note>
|
---|
89 |
|
---|
90 | <para>Build the module: </para>
|
---|
91 |
|
---|
92 | &build-wheel;
|
---|
93 |
|
---|
94 | <para>
|
---|
95 | This package does not come with a working test suite.
|
---|
96 | </para>
|
---|
97 |
|
---|
98 | <para>
|
---|
99 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
100 | </para>
|
---|
101 |
|
---|
102 | <screen role="root"><userinput>&install-wheel; smartypants</userinput></screen>
|
---|
103 |
|
---|
104 | <para>
|
---|
105 | To test the results, issue:
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <screen remap="test"><userinput>sed 's/assertEquals/assertEqual/' -i tests/test_cli.py &&
|
---|
109 | cp /usr/bin/smartypants . &&
|
---|
110 | pytest</userinput></screen>
|
---|
111 |
|
---|
112 | </sect3>
|
---|
113 |
|
---|
114 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
115 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
116 |
|
---|
117 | <sect3 role="content">
|
---|
118 | <title>Contents</title>
|
---|
119 |
|
---|
120 | <segmentedlist>
|
---|
121 | <segtitle>Installed Programs</segtitle>
|
---|
122 | <segtitle>Installed Libraries</segtitle>
|
---|
123 | <segtitle>Installed Directories</segtitle>
|
---|
124 |
|
---|
125 | <seglistitem>
|
---|
126 | <seg>smartypants</seg>
|
---|
127 | <seg>None</seg>
|
---|
128 | <seg>
|
---|
129 | /usr/lib/python&python3-majorver;/site-packages/smartypants-&smartypants-version;.dist-info
|
---|
130 | </seg>
|
---|
131 | </seglistitem>
|
---|
132 | </segmentedlist>
|
---|
133 |
|
---|
134 | <variablelist>
|
---|
135 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
136 | <?dbfo list-presentation="list"?>
|
---|
137 | <?dbhtml list-presentation="table"?>
|
---|
138 |
|
---|
139 | <varlistentry id="smartypants-prog">
|
---|
140 | <term><command>smartypants</command></term>
|
---|
141 | <listitem>
|
---|
142 | <para>
|
---|
143 | translates ASCII punctuation to HTML punctuation.
|
---|
144 | </para>
|
---|
145 | <indexterm zone="smartypants smartypants-prog">
|
---|
146 | <primary sortas="b-smartypants-prog">smartypants</primary>
|
---|
147 | </indexterm>
|
---|
148 | </listitem>
|
---|
149 | </varlistentry>
|
---|
150 |
|
---|
151 | </variablelist>
|
---|
152 |
|
---|
153 | </sect3>
|
---|
154 |
|
---|
155 | </sect2>
|
---|