[51b4251] | 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 hatch-fancy-pypi-readme-download-http "https://files.pythonhosted.org/packages/source/h/hatch-fancy-pypi-readme/hatch_fancy_pypi_readme-&hatch-fancy-pypi-readme-version;.tar.gz">
|
---|
| 8 | <!ENTITY hatch-fancy-pypi-readme-download-ftp " ">
|
---|
| 9 | <!ENTITY hatch-fancy-pypi-readme-md5sum "&hatch-fancy-pypi-readme-md5sum;">
|
---|
| 10 | <!ENTITY hatch-fancy-pypi-readme-size "32 KB">
|
---|
| 11 | <!ENTITY hatch-fancy-pypi-readme-buildsize "388 KB">
|
---|
| 12 | <!ENTITY hatch-fancy-pypi-readme-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="hatch-fancy-pypi-readme" xreflabel="hatch-fancy-pypi-readme-&hatch-fancy-pypi-readme-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Hatch-Fancy-Pypi-Readme-&hatch-fancy-pypi-readme-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="hatch-fancy-pypi-readme">
|
---|
| 20 | <primary sortas="a-hatch-fancy-pypi-readme">hatch-fancy-pypi-readme</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Hatch-Fancy-Pypi-Readme Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | <application>Hatch-Fancy-Pypi-Readme</application> is a hatch plugin
|
---|
| 28 | filling the readme field into the metadata of a Python module from
|
---|
| 29 | markup language documentation files of the module.
|
---|
| 30 | </para>
|
---|
| 31 |
|
---|
[09ddf35a] | 32 | &lfs122_checked;
|
---|
[51b4251] | 33 |
|
---|
| 34 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
| 38 | Download (HTTP): <ulink url="&hatch-fancy-pypi-readme-download-http;"/>
|
---|
| 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (FTP): <ulink url="&hatch-fancy-pypi-readme-download-ftp;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download MD5 sum: &hatch-fancy-pypi-readme-md5sum;
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download size: &hatch-fancy-pypi-readme-size;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Estimated disk space required: &hatch-fancy-pypi-readme-buildsize;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated build time: &hatch-fancy-pypi-readme-time;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
| 68 | <bridgehead renderas="sect4">Hatch-Fancy-Pypi-Readme Dependencies</bridgehead>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 71 | <para role="required">
|
---|
| 72 | <xref linkend="hatchling"/>
|
---|
| 73 | </para>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 76 | <para role="optional">
|
---|
| 77 | <xref linkend="pytest"/> and
|
---|
| 78 | <ulink url="https://pypi.org/project/build/">build</ulink>
|
---|
| 79 | </para>
|
---|
| 80 | </sect3>
|
---|
| 81 |
|
---|
| 82 | <sect3 role="installation">
|
---|
| 83 | <title>Installation of Hatch-Fancy-Pypi-Readme</title>
|
---|
| 84 |
|
---|
| 85 | <para>Build the module: </para>
|
---|
| 86 |
|
---|
| 87 | &build-wheel;
|
---|
| 88 |
|
---|
| 89 | <para>
|
---|
| 90 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <screen role="root"><userinput>&install-wheel; hatch-fancy-pypi-readme</userinput></screen>
|
---|
| 94 |
|
---|
| 95 | <para>
|
---|
| 96 | To test the installation, make sure <xref linkend='pytest'/> is
|
---|
| 97 | installed and run:
|
---|
| 98 | </para>
|
---|
| 99 |
|
---|
| 100 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 101 | testenv/bin/pip3 install 'hatch-fancy-pypi-readme[tests]' &&
|
---|
| 102 | testenv/bin/python -m pytest</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>None</seg>
|
---|
| 119 | <seg>None</seg>
|
---|
| 120 | <seg>
|
---|
| 121 | /usr/lib/python&python3-majorver;/site-packages/hatch_fancy_pypi_readme and
|
---|
| 122 | /usr/lib/python&python3-majorver;/site-packages/hatch_fancy_pypi_readme-&hatch-fancy-pypi-readme-version;.dist-info
|
---|
| 123 | </seg>
|
---|
| 124 | </seglistitem>
|
---|
| 125 | </segmentedlist>
|
---|
| 126 |
|
---|
| 127 | </sect3>
|
---|
| 128 |
|
---|
| 129 | </sect2>
|
---|