[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[3d48ae4] | 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 |
|
---|
[5d51dad6] | 7 | <!ENTITY sphinx-download-http "https://files.pythonhosted.org/packages/source/s/sphinx/sphinx-&sphinx-version;.tar.gz">
|
---|
[3d48ae4] | 8 | <!ENTITY sphinx-download-ftp " ">
|
---|
[ee14f5f] | 9 | <!ENTITY sphinx-md5sum "9f07671060e83d92a7a4e33893bbd408">
|
---|
| 10 | <!ENTITY sphinx-size "7.8 MB">
|
---|
| 11 | <!ENTITY sphinx-buildsize "57 MB (with tests)">
|
---|
| 12 | <!ENTITY sphinx-time "less than 0.1 SBU (add 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 |
|
---|
[09ddf35a] | 32 | &lfs122_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"/>,
|
---|
[a3e69b9b] | 91 | <xref linkend="html5lib"/>,
|
---|
[72c62e4] | 92 | <xref linkend="pytest"/>,
|
---|
[6cbba3e4] | 93 | <xref linkend="texlive"/>,
|
---|
| 94 | <ulink url="https://pypi.org/project/defusedxml/">defusedxml</ulink>, and
|
---|
[5264b6f] | 95 | <ulink url="https://pypi.org/project/typing_extensions/">typing_extensions</ulink>
|
---|
[3d48ae4] | 96 | </para>
|
---|
| 97 |
|
---|
| 98 | </sect3>
|
---|
| 99 |
|
---|
| 100 | <sect3 role="installation">
|
---|
| 101 | <title>Installation of Sphinx</title>
|
---|
| 102 |
|
---|
[017f8af] | 103 | <para>Build the module:</para>
|
---|
[3d48ae4] | 104 |
|
---|
[db244ae2] | 105 | &build-wheel;
|
---|
[3d48ae4] | 106 |
|
---|
| 107 | <para>
|
---|
[74434cc] | 108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[3d48ae4] | 109 | </para>
|
---|
| 110 |
|
---|
[db244ae2] | 111 | <screen role="root"><userinput>&install-wheel; sphinx</userinput></screen>
|
---|
[74434cc] | 112 |
|
---|
[3d48ae4] | 113 | <para>
|
---|
[74434cc] | 114 | Assuming <xref linkend="cython"/> and <xref linkend="pytest"/> are
|
---|
[5c5417a8] | 115 | installed, but the other optional dependencies are not, the installation
|
---|
[74434cc] | 116 | can be tested with the following commands:
|
---|
[3d48ae4] | 117 | </para>
|
---|
| 118 |
|
---|
[74434cc] | 119 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 120 | source testenv/bin/activate &&
|
---|
[7b86a32] | 121 | pip3 install sphinx[test] &&
|
---|
[5c5417a8] | 122 | python3 -m pytest<!-- no && because of a possible error -->
|
---|
[74434cc] | 123 | deactivate</userinput></screen>
|
---|
[e440af5] | 124 | <!-- No failure in 7.0.1 [pierre]
|
---|
[a858014f] | 125 | 7.1.0: 4 failed, 1896 passed, 10 skipped in 108.14s (0:01:48)
|
---|
| 126 | test_imgmath_png, test_imgmath_svg, test_imgmath_svg_embed, test_imgmath_numfig_html
|
---|
[5c5417a8] | 127 | 7.2.5: 2051 passed, 11 skipped, 4 warnings [pierre]
|
---|
[6cbba3e4] | 128 | 7.2.6: 2052 passed, 10 skipped, 6 warnings [pierre]
|
---|
| 129 | 7.3.7: 2124 passed, 20 skipped, 35 warnings in 123.27s [bdubbs]
|
---|
[31ddfc35] | 130 | -->
|
---|
[3d48ae4] | 131 | </sect3>
|
---|
| 132 |
|
---|
| 133 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 134 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 135 |
|
---|
| 136 | <sect3 role="content">
|
---|
| 137 | <title>Contents</title>
|
---|
| 138 |
|
---|
| 139 | <segmentedlist>
|
---|
| 140 | <segtitle>Installed Programs</segtitle>
|
---|
| 141 | <segtitle>Installed Libraries</segtitle>
|
---|
| 142 | <segtitle>Installed Directories</segtitle>
|
---|
| 143 |
|
---|
| 144 | <seglistitem>
|
---|
| 145 | <seg>
|
---|
[2a0f15bc] | 146 | sphinx-apidoc, sphinx-autogen, sphinx-build, and sphinx-quickstart
|
---|
[3d48ae4] | 147 | </seg>
|
---|
| 148 | <seg>None</seg>
|
---|
| 149 | <seg>
|
---|
[2a0f15bc] | 150 | /usr/lib/python&python3-majorver;/site-packages/sphinx and
|
---|
| 151 | /usr/lib/python&python3-majorver;/site-packages/sphinx-&sphinx-version;.dist-info
|
---|
[3d48ae4] | 152 | </seg>
|
---|
| 153 | </seglistitem>
|
---|
| 154 | </segmentedlist>
|
---|
[2a0f15bc] | 155 |
|
---|
[3d48ae4] | 156 | <variablelist>
|
---|
| 157 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 158 | <?dbfo list-presentation="list"?>
|
---|
| 159 | <?dbhtml list-presentation="table"?>
|
---|
| 160 |
|
---|
[2a0f15bc] | 161 | <varlistentry id="sphinx-apidoc">
|
---|
| 162 | <term><command>sphinx-apidoc</command></term>
|
---|
| 163 | <listitem>
|
---|
| 164 | <para>
|
---|
| 165 | creates an reST file from python modules and packages
|
---|
| 166 | </para>
|
---|
| 167 | <indexterm zone="sphinx sphinx-apidoc">
|
---|
| 168 | <primary sortas="b-sphinx-apidoc">sphinx-apidoc</primary>
|
---|
| 169 | </indexterm>
|
---|
| 170 | </listitem>
|
---|
| 171 | </varlistentry>
|
---|
| 172 |
|
---|
| 173 | <varlistentry id="sphinx-autogen">
|
---|
| 174 | <term><command>sphinx-autogen</command></term>
|
---|
[3d48ae4] | 175 | <listitem>
|
---|
| 176 | <para>
|
---|
[2a0f15bc] | 177 | generates ReStructuredText from special directives contained
|
---|
| 178 | in given input files
|
---|
[3d48ae4] | 179 | </para>
|
---|
[2a0f15bc] | 180 | <indexterm zone="sphinx sphinx-autogen">
|
---|
| 181 | <primary sortas="b-sphinx-autogen">sphinx-autogen</primary>
|
---|
[3d48ae4] | 182 | </indexterm>
|
---|
| 183 | </listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
[2a0f15bc] | 186 | <varlistentry id="sphinx-build">
|
---|
| 187 | <term><command>sphinx-build</command></term>
|
---|
[3d48ae4] | 188 | <listitem>
|
---|
| 189 | <para>
|
---|
[2a0f15bc] | 190 | generates documentation in various formats from ReStructuredText
|
---|
| 191 | source files
|
---|
[3d48ae4] | 192 | </para>
|
---|
[2a0f15bc] | 193 | <indexterm zone="sphinx sphinx-build">
|
---|
| 194 | <primary sortas="b-sphinx-build">sphinx-build</primary>
|
---|
| 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
| 199 | <varlistentry id="sphinx-quickstart">
|
---|
| 200 | <term><command>sphinx-quickstart</command></term>
|
---|
| 201 | <listitem>
|
---|
| 202 | <para>
|
---|
| 203 | generates required files for a sphinx project
|
---|
| 204 | </para>
|
---|
| 205 | <indexterm zone="sphinx sphinx-quickstart">
|
---|
| 206 | <primary sortas="b-sphinx-quickstart">sphinx-quickstart</primary>
|
---|
[3d48ae4] | 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
| 210 |
|
---|
| 211 | </variablelist>
|
---|
[2a0f15bc] | 212 |
|
---|
[3d48ae4] | 213 | </sect3>
|
---|
| 214 |
|
---|
| 215 | </sect2>
|
---|