[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 " ">
|
---|
| 9 | <!ENTITY sphinx-md5sum "a8444ced81cd594d60d4af002a0e0025">
|
---|
| 10 | <!ENTITY sphinx-size "6.5 MB">
|
---|
| 11 | <!ENTITY sphinx-buildsize "2.6 MB">
|
---|
| 12 | <!ENTITY sphinx-time "less than 0.1 SBU">
|
---|
| 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 |
|
---|
| 32 | &lfs112_checked;
|
---|
| 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"/>,
|
---|
[0cf85fa] | 76 | <phrase revision="sysv"><xref linkend="Jinja2"/>,</phrase>
|
---|
[3d48ae4] | 77 | <xref linkend="packaging"/>,
|
---|
| 78 | <xref linkend="pygments"/>,
|
---|
| 79 | <xref linkend="requests"/>,
|
---|
| 80 | <xref linkend="snowballstemmer"/>,
|
---|
| 81 | <xref linkend="sphinxcontrib-applehelp"/>,
|
---|
| 82 | <xref linkend="sphinxcontrib-devhelp"/>,
|
---|
| 83 | <xref linkend="sphinxcontrib-htmlhelp"/>,
|
---|
| 84 | <xref linkend="sphinxcontrib-jsmath"/>,
|
---|
| 85 | <xref linkend="sphinxcontrib-qthelp"/>, and
|
---|
| 86 | <xref linkend="sphinxcontrib-serializinghtml"/>
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect5">Optional</bridgehead>
|
---|
| 90 | <para role="optional">
|
---|
| 91 | <xref linkend="cython"/> (for tests),
|
---|
| 92 | <ulink url="https://pypi.org/project/docutils-stubs/">
|
---|
| 93 | docutils-stubs
|
---|
| 94 | </ulink>,
|
---|
| 95 | <ulink url="https://pypi.org/project/flake8/">
|
---|
| 96 | flake8
|
---|
| 97 | </ulink>,
|
---|
| 98 | <ulink url="https://pypi.org/project/flake8-comprehensions/">
|
---|
| 99 | flake8-comprehensions
|
---|
| 100 | </ulink>,
|
---|
| 101 | <ulink url="https://pypi.org/project/flake8-bugbear/">
|
---|
| 102 | flake8-bugbear
|
---|
| 103 | </ulink>,
|
---|
| 104 | <ulink url="https://pypi.org/project/flake8-simplify/">
|
---|
| 105 | flake8-simplify
|
---|
| 106 | </ulink>,
|
---|
| 107 | <ulink url="https://pypi.org/project/html5lib/">
|
---|
| 108 | html5lib
|
---|
| 109 | </ulink> (for tests),
|
---|
| 110 | <ulink url="https://pypi.org/project/isort/">
|
---|
| 111 | isort
|
---|
| 112 | </ulink>,
|
---|
| 113 | <ulink url="https://pypi.org/project/mypy/">
|
---|
| 114 | mypy
|
---|
| 115 | </ulink>,
|
---|
| 116 | <xref linkend="pytest"/> (for tests),
|
---|
| 117 | <ulink url="https://pypi.org/project/sphinx-lint/">
|
---|
| 118 | sphinx-lint
|
---|
| 119 | </ulink>,
|
---|
| 120 | <ulink url="https://pypi.org/project/sphinxcontrib-websupport/">
|
---|
| 121 | sphinxcontrib-websupport
|
---|
| 122 | </ulink> (for building documentation),
|
---|
| 123 | <ulink url="https://pypi.org/project/types-requests/">
|
---|
| 124 | types-requests
|
---|
| 125 | </ulink>, and
|
---|
| 126 | <ulink url="https://pypi.org/project/types-typed-ast/">
|
---|
| 127 | types-typed-ast
|
---|
| 128 | </ulink>,
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
| 131 | </sect3>
|
---|
| 132 |
|
---|
| 133 | <sect3 role="installation">
|
---|
| 134 | <title>Installation of Sphinx</title>
|
---|
| 135 |
|
---|
| 136 | <para> Build the module: </para>
|
---|
| 137 |
|
---|
| 138 | <screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
| 139 |
|
---|
| 140 | <para>
|
---|
| 141 | This package does not come with a test suite.
|
---|
| 142 | </para>
|
---|
| 143 |
|
---|
| 144 | <para>
|
---|
| 145 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 146 | </para>
|
---|
| 147 |
|
---|
| 148 | <screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user asciidoc</userinput></screen>
|
---|
| 149 |
|
---|
| 150 | </sect3>
|
---|
| 151 |
|
---|
| 152 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 153 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 154 |
|
---|
| 155 | <sect3 role="content">
|
---|
| 156 | <title>Contents</title>
|
---|
| 157 |
|
---|
| 158 | <segmentedlist>
|
---|
| 159 | <segtitle>Installed Programs</segtitle>
|
---|
| 160 | <segtitle>Installed Libraries</segtitle>
|
---|
| 161 | <segtitle>Installed Directories</segtitle>
|
---|
| 162 |
|
---|
| 163 | <seglistitem>
|
---|
| 164 | <seg>
|
---|
| 165 | a2x and
|
---|
| 166 | asciidoc
|
---|
| 167 | </seg>
|
---|
| 168 | <seg>None</seg>
|
---|
| 169 | <seg>
|
---|
| 170 | /usr/lib/python&python3-majorver;/site-packages/asciidoc and
|
---|
| 171 | /usr/lib/python&python3-majorver;/site-packages/asciidoc-&asciidoc-version;.dist-info
|
---|
| 172 | </seg>
|
---|
| 173 | </seglistitem>
|
---|
| 174 | </segmentedlist>
|
---|
[0cf85fa] | 175 | <!--
|
---|
[3d48ae4] | 176 | <variablelist>
|
---|
| 177 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 178 | <?dbfo list-presentation="list"?>
|
---|
| 179 | <?dbhtml list-presentation="table"?>
|
---|
| 180 |
|
---|
| 181 | <varlistentry id="a2x">
|
---|
| 182 | <term><command>a2x</command></term>
|
---|
| 183 | <listitem>
|
---|
| 184 | <para>
|
---|
| 185 | is a toolchain manager for AsciiDoc
|
---|
| 186 | (converts Asciidoc text files to other file formats)
|
---|
| 187 | </para>
|
---|
| 188 | <indexterm zone="asciidoc a2x">
|
---|
| 189 | <primary sortas="b-a2x">a2x</primary>
|
---|
| 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
| 193 |
|
---|
| 194 | <varlistentry id="asciidoc-prog">
|
---|
| 195 | <term><command>asciidoc</command></term>
|
---|
| 196 | <listitem>
|
---|
| 197 | <para>
|
---|
| 198 | converts an AsciiDoc text file to HTML or DocBook
|
---|
| 199 | </para>
|
---|
| 200 | <indexterm zone="asciidoc asciidoc-prog">
|
---|
| 201 | <primary sortas="b-asciidoc-prog">asciidoc</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
| 204 | </varlistentry>
|
---|
| 205 |
|
---|
| 206 | </variablelist>
|
---|
[0cf85fa] | 207 | -->
|
---|
[3d48ae4] | 208 | </sect3>
|
---|
| 209 |
|
---|
| 210 | </sect2>
|
---|