[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[0cf85fa] | 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 |
|
---|
[234bc845] | 7 | <!ENTITY sc-devhelp-download-http "https://files.pythonhosted.org/packages/source/s/sphinxcontrib-devhelp/sphinxcontrib_devhelp-&sc-devhelp-version;.tar.gz">
|
---|
[036821b] | 8 | <!ENTITY sc-devhelp-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY sc-devhelp-md5sum "&sc-devhelp-md5sum;">
|
---|
[234bc845] | 10 | <!ENTITY sc-devhelp-size "16 KB">
|
---|
| 11 | <!ENTITY sc-devhelp-buildsize "984 MB (with tests)">
|
---|
[72c62e4] | 12 | <!ENTITY sc-devhelp-time "less than 0.1 SBU (with tests)">
|
---|
[0cf85fa] | 13 | ]>
|
---|
| 14 |
|
---|
[036821b] | 15 | <sect2 id="sc-devhelp" xreflabel="sphinxcontrib-devhelp-&sc-devhelp-version;">
|
---|
[0cf85fa] | 16 |
|
---|
[036821b] | 17 | <title>Sphinxcontrib-devhelp-&sc-devhelp-version;</title>
|
---|
[0cf85fa] | 18 |
|
---|
[036821b] | 19 | <indexterm zone="sc-devhelp">
|
---|
| 20 | <primary sortas="a-sphinxcontrib-devhelp">sphinxcontrib-devhelp</primary>
|
---|
[0cf85fa] | 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
[036821b] | 24 | <title>Introduction to Sphinxcontrib-devhelp Module</title>
|
---|
[0cf85fa] | 25 |
|
---|
| 26 | <para>
|
---|
[036821b] | 27 | The <application>Sphinxcontrib-devhelp</application> package is a
|
---|
| 28 | <application>Sphinx</application> extension which outputs
|
---|
| 29 | <ulink url="https://wiki.gnome.org/Apps/Devhelp">Devhelp</ulink>
|
---|
| 30 | documents.
|
---|
[0cf85fa] | 31 | </para>
|
---|
| 32 |
|
---|
[09ddf35a] | 33 | &lfs122_checked;
|
---|
[0cf85fa] | 34 |
|
---|
| 35 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
[036821b] | 39 | Download (HTTP): <ulink url="&sc-devhelp-download-http;"/>
|
---|
[0cf85fa] | 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
[036821b] | 44 | Download (FTP): <ulink url="&sc-devhelp-download-ftp;"/>
|
---|
[0cf85fa] | 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
[036821b] | 49 | Download MD5 sum: &sc-devhelp-md5sum;
|
---|
[0cf85fa] | 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
[036821b] | 54 | Download size: &sc-devhelp-size;
|
---|
[0cf85fa] | 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
[036821b] | 59 | Estimated disk space required: &sc-devhelp-buildsize;
|
---|
[0cf85fa] | 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
[036821b] | 64 | Estimated build time: &sc-devhelp-time;
|
---|
[0cf85fa] | 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
[036821b] | 69 | <bridgehead renderas="sect4">Sphinxcontrib-devhelp Dependencies</bridgehead>
|
---|
[0cf85fa] | 70 |
|
---|
[74434cc] | 71 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
[0cf85fa] | 72 | <para role="optional">
|
---|
[72c62e4] | 73 | <xref linkend="pytest"/> and
|
---|
| 74 | <xref linkend="sphinx"/> (circular dependency)
|
---|
[0cf85fa] | 75 | </para>
|
---|
| 76 |
|
---|
| 77 | </sect3>
|
---|
| 78 |
|
---|
| 79 | <sect3 role="installation">
|
---|
[036821b] | 80 | <title>Installation of Sphinxcontrib-devhelp</title>
|
---|
[0cf85fa] | 81 |
|
---|
| 82 | <para> Build the module: </para>
|
---|
| 83 |
|
---|
[082e722] | 84 | &build-wheel;
|
---|
[0cf85fa] | 85 |
|
---|
| 86 | <para>
|
---|
| 87 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 88 | </para>
|
---|
| 89 |
|
---|
[082e722] | 90 | <screen role="root"><userinput>&install-wheel; sphinxcontrib-devhelp</userinput></screen>
|
---|
[0cf85fa] | 91 |
|
---|
[74434cc] | 92 | <para>
|
---|
| 93 | To test the installation, run <command>pytest</command>.
|
---|
| 94 | </para>
|
---|
| 95 |
|
---|
[0cf85fa] | 96 | </sect3>
|
---|
| 97 |
|
---|
| 98 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 99 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 100 |
|
---|
| 101 | <sect3 role="content">
|
---|
| 102 | <title>Contents</title>
|
---|
| 103 |
|
---|
| 104 | <segmentedlist>
|
---|
| 105 | <segtitle>Installed Programs</segtitle>
|
---|
| 106 | <segtitle>Installed Libraries</segtitle>
|
---|
| 107 | <segtitle>Installed Directories</segtitle>
|
---|
| 108 |
|
---|
| 109 | <seglistitem>
|
---|
[036821b] | 110 | <seg>None</seg>
|
---|
[0cf85fa] | 111 | <seg>None</seg>
|
---|
| 112 | <seg>
|
---|
[036821b] | 113 | /usr/lib/python&python3-majorver;/site-packages/sphinxcontrib and
|
---|
[301c411] | 114 | /usr/lib/python&python3-majorver;/site-packages/sphinxcontrib_devhelp-&sc-devhelp-version;.dist-info
|
---|
[0cf85fa] | 115 | </seg>
|
---|
| 116 | </seglistitem>
|
---|
| 117 | </segmentedlist>
|
---|
[036821b] | 118 |
|
---|
[0cf85fa] | 119 | </sect3>
|
---|
| 120 |
|
---|
| 121 | </sect2>
|
---|