[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[07f61e4] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[5fe69261] | 4 | <!ENTITY % general-entities SYSTEM "../../../general.ent">
|
---|
[07f61e4] | 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY pygments-download-http
|
---|
[9ccad19] | 8 | "https://files.pythonhosted.org/packages/source/P/Pygments/pygments-&pygments-version;.tar.gz">
|
---|
[07f61e4] | 9 | <!ENTITY pygments-download-ftp " ">
|
---|
[569925c7] | 10 | <!ENTITY pygments-md5sum "&pygments-md5sum;">
|
---|
[627bb15] | 11 | <!ENTITY pygments-size "4.7 MB">
|
---|
| 12 | <!ENTITY pygments-buildsize "52 MB">
|
---|
[baa0c93f] | 13 | <!ENTITY pygments-time "less than 0.1 SBU">
|
---|
[07f61e4] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <!-- Begin Pygments -->
|
---|
| 17 | <sect2 id="pygments" xreflabel="Pygments-&pygments-version;">
|
---|
| 18 |
|
---|
| 19 | <title>Pygments-&pygments-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="pygments">
|
---|
| 22 | <primary sortas="a-Pygments">Pygments</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect3 role="package">
|
---|
| 26 | <title>Introduction to Pygments Module</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | <application>Pygments</application> is a general syntax highlighter
|
---|
| 30 | written in <application>Python</application>, for more than 300
|
---|
| 31 | languages.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[09ddf35a] | 34 | &lfs122_checked;
|
---|
[07f61e4] | 35 |
|
---|
| 36 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&pygments-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&pygments-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &pygments-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &pygments-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &pygments-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &pygments-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
[e2d263e] | 70 | <bridgehead renderas="sect3">Pygments Dependencies</bridgehead>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 73 | <para role="required">
|
---|
| 74 | <xref linkend="hatchling"/>
|
---|
| 75 | </para>
|
---|
| 76 |
|
---|
[793b567] | 77 | <bridgehead renderas="sect4">Optional (for testing)</bridgehead>
|
---|
| 78 | <para role="optional">
|
---|
| 79 | <xref linkend="pytest"/> and
|
---|
| 80 | <ulink url='https://pypi.org/project/wcag-contrast-ratio'>wcag-contrast-ratio</ulink>
|
---|
| 81 | </para>
|
---|
| 82 |
|
---|
[07f61e4] | 83 | </sect3>
|
---|
| 84 |
|
---|
| 85 | <sect3 role="installation">
|
---|
| 86 | <title>Installation of Pygments</title>
|
---|
| 87 |
|
---|
| 88 | <para>
|
---|
[c8a0d6c0] | 89 | Build the <application>Python 3</application> module:
|
---|
[07f61e4] | 90 | </para>
|
---|
| 91 |
|
---|
[db244ae2] | 92 | &build-wheel;
|
---|
[c8a0d6c0] | 93 |
|
---|
| 94 | <para>
|
---|
[7a9a7b26] | 95 | To install the package run the following as the &root; user:
|
---|
[c8a0d6c0] | 96 | </para>
|
---|
| 97 |
|
---|
[db244ae2] | 98 | <screen role="root"><userinput>&install-wheel; Pygments</userinput></screen>
|
---|
[07f61e4] | 99 |
|
---|
[793b567] | 100 | <para>
|
---|
| 101 | To test the installation, make sure <xref linkend='pytest'/> is
|
---|
| 102 | installed and run:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 106 | testenv/bin/pip3 install wcag-contrast-ratio &&
|
---|
| 107 | testenv/bin/python -m pytest</userinput></screen>
|
---|
| 108 |
|
---|
[07f61e4] | 109 | </sect3>
|
---|
| 110 |
|
---|
[00b0be00] | 111 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[5fe69261] | 112 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
[00b0be00] | 113 |
|
---|
[07f61e4] | 114 | <sect3 role="content">
|
---|
| 115 | <title>Contents</title>
|
---|
| 116 |
|
---|
| 117 | <segmentedlist>
|
---|
| 118 | <segtitle>Installed Programs</segtitle>
|
---|
| 119 | <segtitle>Installed Library</segtitle>
|
---|
| 120 | <segtitle>Installed Directories</segtitle>
|
---|
| 121 |
|
---|
| 122 | <seglistitem>
|
---|
| 123 | <seg>
|
---|
| 124 | pygmentize
|
---|
| 125 | </seg>
|
---|
| 126 | <seg>
|
---|
| 127 | None
|
---|
| 128 | </seg>
|
---|
| 129 | <seg>
|
---|
[72c62e4] | 130 | /usr/lib/python&python3-majorver;/site-packages/pygments and
|
---|
[c8a0d6c0] | 131 | /usr/lib/python&python3-majorver;/site-packages/Pygments-&pygments-version;.dist-info
|
---|
[07f61e4] | 132 | </seg>
|
---|
| 133 | </seglistitem>
|
---|
| 134 | </segmentedlist>
|
---|
| 135 |
|
---|
[fdfe117] | 136 | <variablelist>
|
---|
| 137 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 138 | <?dbfo list-presentation="list"?>
|
---|
| 139 | <?dbhtml list-presentation="table"?>
|
---|
| 140 |
|
---|
[72c62e4] | 141 | <varlistentry id="pygmentize">
|
---|
| 142 | <term><command>pygmentize</command></term>
|
---|
| 143 | <listitem>
|
---|
| 144 | <para>
|
---|
| 145 | highlights an input file and writes the result to an output file
|
---|
| 146 | </para>
|
---|
| 147 | <indexterm zone="pygments pygmentize">
|
---|
| 148 | <primary sortas="b-pygmentize">pygmentize</primary>
|
---|
| 149 | </indexterm>
|
---|
| 150 | </listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 |
|
---|
| 153 | </variablelist>
|
---|
| 154 |
|
---|
[07f61e4] | 155 | </sect3>
|
---|
| 156 |
|
---|
| 157 | </sect2>
|
---|