[3d48ae4] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 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 sphinx-download-http "https://github.com/sphinx-doc/sphinx/archive/v&sphinx-version;/sphinx-&sphinx-version;.tar.gz">
|
---|
| 8 | <!ENTITY sphinx-download-ftp " ">
|
---|
[61f3e811] | 9 | <!ENTITY sphinx-md5sum "ae8427a2035ebd4359c3df8f5436c4b9">
|
---|
[a858014f] | 10 | <!ENTITY sphinx-size "6.6 MB">
|
---|
[1c19af5] | 11 | <!ENTITY sphinx-buildsize "27 MB (add 40 MB for tests)">
|
---|
[a858014f] | 12 | <!ENTITY sphinx-time "less than 0.1 SBU (1.0 SBU for tests)">
|
---|
[3d48ae4] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="sphinx" xreflabel="sphinx-&sphinx-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Sphinx-&sphinx-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="sphinx">
|
---|
| 20 | <primary sortas="a-sphinx">sphinx</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Sphinx Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>Sphinx</application> package is a set of tools
|
---|
| 28 | for translating some structured text formats into pretty documentation
|
---|
| 29 | in various formats.
|
---|
| 30 | </para>
|
---|
| 31 |
|
---|
[ed345e7] | 32 | &lfs120_checked;
|
---|
[3d48ae4] | 33 |
|
---|
| 34 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
| 38 | Download (HTTP): <ulink url="&sphinx-download-http;"/>
|
---|
| 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (FTP): <ulink url="&sphinx-download-ftp;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download MD5 sum: &sphinx-md5sum;
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download size: &sphinx-size;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Estimated disk space required: &sphinx-buildsize;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated build time: &sphinx-time;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
| 68 | <bridgehead renderas="sect4">Sphinx Dependencies</bridgehead>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 71 | <para role="required">
|
---|
| 72 | <xref linkend="alabaster"/>,
|
---|
| 73 | <xref linkend="babel"/>,
|
---|
| 74 | <xref linkend="docutils"/>,
|
---|
| 75 | <xref linkend="imagesize"/>,
|
---|
| 76 | <xref linkend="packaging"/>,
|
---|
| 77 | <xref linkend="pygments"/>,
|
---|
| 78 | <xref linkend="requests"/>,
|
---|
| 79 | <xref linkend="snowballstemmer"/>,
|
---|
[036821b] | 80 | <xref linkend="sc-applehelp"/>,
|
---|
| 81 | <xref linkend="sc-devhelp"/>,
|
---|
| 82 | <xref linkend="sc-htmlhelp"/>,
|
---|
| 83 | <xref linkend="sc-jsmath"/>,
|
---|
| 84 | <xref linkend="sc-qthelp"/>, and
|
---|
| 85 | <xref linkend="sc-serializinghtml"/>
|
---|
[3d48ae4] | 86 | </para>
|
---|
| 87 |
|
---|
[74434cc] | 88 | <bridgehead renderas="sect5">Optional (for tests)</bridgehead>
|
---|
[3d48ae4] | 89 | <para role="optional">
|
---|
[74434cc] | 90 | <xref linkend="cython"/>,
|
---|
[72c62e4] | 91 | <xref linkend="pytest"/>,
|
---|
[1d6fda1] | 92 | <xref linkend="texlive"/>,
|
---|
| 93 | <ulink url="https://pypi.org/project/filelock/">filelock</ulink>, and
|
---|
[74434cc] | 94 | <ulink url="https://pypi.org/project/html5lib/">html5lib</ulink>
|
---|
[3d48ae4] | 95 | </para>
|
---|
| 96 |
|
---|
| 97 | </sect3>
|
---|
| 98 |
|
---|
| 99 | <sect3 role="installation">
|
---|
| 100 | <title>Installation of Sphinx</title>
|
---|
| 101 |
|
---|
| 102 | <para> Build the module: </para>
|
---|
| 103 |
|
---|
| 104 | <screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
| 105 |
|
---|
| 106 | <para>
|
---|
[74434cc] | 107 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[3d48ae4] | 108 | </para>
|
---|
| 109 |
|
---|
[74434cc] | 110 | <screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user sphinx</userinput></screen>
|
---|
| 111 |
|
---|
[3d48ae4] | 112 | <para>
|
---|
[74434cc] | 113 | Assuming <xref linkend="cython"/> and <xref linkend="pytest"/> are
|
---|
| 114 | installed, but the other optional dependency is not, the installation
|
---|
| 115 | can be tested with the following commands:
|
---|
[3d48ae4] | 116 | </para>
|
---|
| 117 |
|
---|
[74434cc] | 118 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 119 | source testenv/bin/activate &&
|
---|
[1d6fda1] | 120 | pip3 install html5lib filelock &&
|
---|
[74434cc] | 121 | python3 /usr/bin/pytest<!-- no && because of a possible error -->
|
---|
| 122 | deactivate</userinput></screen>
|
---|
[a858014f] | 123 | <!-- No failure in 7.0.1 [pierre]
|
---|
| 124 | 7.1.0: 4 failed, 1896 passed, 10 skipped in 108.14s (0:01:48)
|
---|
| 125 | test_imgmath_png, test_imgmath_svg, test_imgmath_svg_embed, test_imgmath_numfig_html
|
---|
| 126 | -->
|
---|
[ab96df2] | 127 | <para>
|
---|
[8707ac4] | 128 | Four subtests in <command>tests/test_ext_math.py</command>
|
---|
| 129 | are known to fail.
|
---|
[ab96df2] | 130 | </para>
|
---|
[a858014f] | 131 |
|
---|
[3d48ae4] | 132 | </sect3>
|
---|
| 133 |
|
---|
| 134 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 135 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 136 |
|
---|
| 137 | <sect3 role="content">
|
---|
| 138 | <title>Contents</title>
|
---|
| 139 |
|
---|
| 140 | <segmentedlist>
|
---|
| 141 | <segtitle>Installed Programs</segtitle>
|
---|
| 142 | <segtitle>Installed Libraries</segtitle>
|
---|
| 143 | <segtitle>Installed Directories</segtitle>
|
---|
| 144 |
|
---|
| 145 | <seglistitem>
|
---|
| 146 | <seg>
|
---|
[2a0f15bc] | 147 | sphinx-apidoc, sphinx-autogen, sphinx-build, and sphinx-quickstart
|
---|
[3d48ae4] | 148 | </seg>
|
---|
| 149 | <seg>None</seg>
|
---|
| 150 | <seg>
|
---|
[2a0f15bc] | 151 | /usr/lib/python&python3-majorver;/site-packages/sphinx and
|
---|
| 152 | /usr/lib/python&python3-majorver;/site-packages/sphinx-&sphinx-version;.dist-info
|
---|
[3d48ae4] | 153 | </seg>
|
---|
| 154 | </seglistitem>
|
---|
| 155 | </segmentedlist>
|
---|
[2a0f15bc] | 156 |
|
---|
[3d48ae4] | 157 | <variablelist>
|
---|
| 158 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 159 | <?dbfo list-presentation="list"?>
|
---|
| 160 | <?dbhtml list-presentation="table"?>
|
---|
| 161 |
|
---|
[2a0f15bc] | 162 | <varlistentry id="sphinx-apidoc">
|
---|
| 163 | <term><command>sphinx-apidoc</command></term>
|
---|
| 164 | <listitem>
|
---|
| 165 | <para>
|
---|
| 166 | creates an reST file from python modules and packages
|
---|
| 167 | </para>
|
---|
| 168 | <indexterm zone="sphinx sphinx-apidoc">
|
---|
| 169 | <primary sortas="b-sphinx-apidoc">sphinx-apidoc</primary>
|
---|
| 170 | </indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
| 173 |
|
---|
| 174 | <varlistentry id="sphinx-autogen">
|
---|
| 175 | <term><command>sphinx-autogen</command></term>
|
---|
[3d48ae4] | 176 | <listitem>
|
---|
| 177 | <para>
|
---|
[2a0f15bc] | 178 | generates ReStructuredText from special directives contained
|
---|
| 179 | in given input files
|
---|
[3d48ae4] | 180 | </para>
|
---|
[2a0f15bc] | 181 | <indexterm zone="sphinx sphinx-autogen">
|
---|
| 182 | <primary sortas="b-sphinx-autogen">sphinx-autogen</primary>
|
---|
[3d48ae4] | 183 | </indexterm>
|
---|
| 184 | </listitem>
|
---|
| 185 | </varlistentry>
|
---|
| 186 |
|
---|
[2a0f15bc] | 187 | <varlistentry id="sphinx-build">
|
---|
| 188 | <term><command>sphinx-build</command></term>
|
---|
[3d48ae4] | 189 | <listitem>
|
---|
| 190 | <para>
|
---|
[2a0f15bc] | 191 | generates documentation in various formats from ReStructuredText
|
---|
| 192 | source files
|
---|
[3d48ae4] | 193 | </para>
|
---|
[2a0f15bc] | 194 | <indexterm zone="sphinx sphinx-build">
|
---|
| 195 | <primary sortas="b-sphinx-build">sphinx-build</primary>
|
---|
| 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
| 199 |
|
---|
| 200 | <varlistentry id="sphinx-quickstart">
|
---|
| 201 | <term><command>sphinx-quickstart</command></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>
|
---|
| 204 | generates required files for a sphinx project
|
---|
| 205 | </para>
|
---|
| 206 | <indexterm zone="sphinx sphinx-quickstart">
|
---|
| 207 | <primary sortas="b-sphinx-quickstart">sphinx-quickstart</primary>
|
---|
[3d48ae4] | 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
| 212 | </variablelist>
|
---|
[2a0f15bc] | 213 |
|
---|
[3d48ae4] | 214 | </sect3>
|
---|
| 215 |
|
---|
| 216 | </sect2>
|
---|