mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-27 09:42:12 +08:00
Begin to add sphinx
This commit is contained in:
Pierre Labastie
parent
1ff0f0cd70
commit
3d48ae4f2a
210
general/prog/python-modules/sphinx.xml
Normal file
210
general/prog/python-modules/sphinx.xml
Normal file
@ -0,0 +1,210 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % general-entities SYSTEM "../../../general.ent">
|
||||
%general-entities;
|
||||
|
||||
<!ENTITY sphinx-download-http "https://github.com/sphinx-doc/sphinx/archive/v&sphinx-version;/sphinx-&sphinx-version;.tar.gz">
|
||||
<!ENTITY sphinx-download-ftp " ">
|
||||
<!ENTITY sphinx-md5sum "a8444ced81cd594d60d4af002a0e0025">
|
||||
<!ENTITY sphinx-size "6.5 MB">
|
||||
<!ENTITY sphinx-buildsize "2.6 MB">
|
||||
<!ENTITY sphinx-time "less than 0.1 SBU">
|
||||
]>
|
||||
|
||||
<sect2 id="sphinx" xreflabel="sphinx-&sphinx-version;">
|
||||
|
||||
<title>Sphinx-&sphinx-version;</title>
|
||||
|
||||
<indexterm zone="sphinx">
|
||||
<primary sortas="a-sphinx">sphinx</primary>
|
||||
</indexterm>
|
||||
|
||||
<sect3 role="package">
|
||||
<title>Introduction to Sphinx Module</title>
|
||||
|
||||
<para>
|
||||
The <application>Sphinx</application> package is a set of tools
|
||||
for translating some structured text formats into pretty documentation
|
||||
in various formats.
|
||||
</para>
|
||||
|
||||
&lfs112_checked;
|
||||
|
||||
<bridgehead renderas="sect4">Package Information</bridgehead>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>
|
||||
Download (HTTP): <ulink url="&sphinx-download-http;"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Download (FTP): <ulink url="&sphinx-download-ftp;"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Download MD5 sum: &sphinx-md5sum;
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Download size: &sphinx-size;
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Estimated disk space required: &sphinx-buildsize;
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Estimated build time: &sphinx-time;
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<bridgehead renderas="sect4">Sphinx Dependencies</bridgehead>
|
||||
|
||||
<bridgehead renderas="sect5">Required</bridgehead>
|
||||
<para role="required">
|
||||
<xref linkend="alabaster"/>,
|
||||
<xref linkend="babel"/>,
|
||||
<xref linkend="docutils"/>,
|
||||
<xref linkend="imagesize"/>,
|
||||
<phrase revision="sysv"><xref linkend="jinja2"/>,</phrase>
|
||||
<xref linkend="packaging"/>,
|
||||
<xref linkend="pygments"/>,
|
||||
<xref linkend="requests"/>,
|
||||
<xref linkend="snowballstemmer"/>,
|
||||
<xref linkend="sphinxcontrib-applehelp"/>,
|
||||
<xref linkend="sphinxcontrib-devhelp"/>,
|
||||
<xref linkend="sphinxcontrib-htmlhelp"/>,
|
||||
<xref linkend="sphinxcontrib-jsmath"/>,
|
||||
<xref linkend="sphinxcontrib-qthelp"/>, and
|
||||
<xref linkend="sphinxcontrib-serializinghtml"/>
|
||||
</para>
|
||||
|
||||
<bridgehead renderas="sect5">Optional</bridgehead>
|
||||
<para role="optional">
|
||||
<xref linkend="cython"/> (for tests),
|
||||
<ulink url="https://pypi.org/project/docutils-stubs/">
|
||||
docutils-stubs
|
||||
</ulink>,
|
||||
<ulink url="https://pypi.org/project/flake8/">
|
||||
flake8
|
||||
</ulink>,
|
||||
<ulink url="https://pypi.org/project/flake8-comprehensions/">
|
||||
flake8-comprehensions
|
||||
</ulink>,
|
||||
<ulink url="https://pypi.org/project/flake8-bugbear/">
|
||||
flake8-bugbear
|
||||
</ulink>,
|
||||
<ulink url="https://pypi.org/project/flake8-simplify/">
|
||||
flake8-simplify
|
||||
</ulink>,
|
||||
<ulink url="https://pypi.org/project/html5lib/">
|
||||
html5lib
|
||||
</ulink> (for tests),
|
||||
<ulink url="https://pypi.org/project/isort/">
|
||||
isort
|
||||
</ulink>,
|
||||
<ulink url="https://pypi.org/project/mypy/">
|
||||
mypy
|
||||
</ulink>,
|
||||
<xref linkend="pytest"/> (for tests),
|
||||
<ulink url="https://pypi.org/project/sphinx-lint/">
|
||||
sphinx-lint
|
||||
</ulink>,
|
||||
<ulink url="https://pypi.org/project/sphinxcontrib-websupport/">
|
||||
sphinxcontrib-websupport
|
||||
</ulink> (for building documentation),
|
||||
<ulink url="https://pypi.org/project/types-requests/">
|
||||
types-requests
|
||||
</ulink>, and
|
||||
<ulink url="https://pypi.org/project/types-typed-ast/">
|
||||
types-typed-ast
|
||||
</ulink>,
|
||||
</para>
|
||||
|
||||
</sect3>
|
||||
|
||||
<sect3 role="installation">
|
||||
<title>Installation of Sphinx</title>
|
||||
|
||||
<para> Build the module: </para>
|
||||
|
||||
<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
||||
|
||||
<para>
|
||||
This package does not come with a test suite.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Now, as the <systemitem class="username">root</systemitem> user:
|
||||
</para>
|
||||
|
||||
<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user asciidoc</userinput></screen>
|
||||
|
||||
</sect3>
|
||||
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
href="../../../xincludes/pip3-cmd-explain.xml"/>
|
||||
|
||||
<sect3 role="content">
|
||||
<title>Contents</title>
|
||||
|
||||
<segmentedlist>
|
||||
<segtitle>Installed Programs</segtitle>
|
||||
<segtitle>Installed Libraries</segtitle>
|
||||
<segtitle>Installed Directories</segtitle>
|
||||
|
||||
<seglistitem>
|
||||
<seg>
|
||||
a2x and
|
||||
asciidoc
|
||||
</seg>
|
||||
<seg>None</seg>
|
||||
<seg>
|
||||
/usr/lib/python&python3-majorver;/site-packages/asciidoc and
|
||||
/usr/lib/python&python3-majorver;/site-packages/asciidoc-&asciidoc-version;.dist-info
|
||||
</seg>
|
||||
</seglistitem>
|
||||
</segmentedlist>
|
||||
|
||||
<variablelist>
|
||||
<bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
||||
<?dbfo list-presentation="list"?>
|
||||
<?dbhtml list-presentation="table"?>
|
||||
|
||||
<varlistentry id="a2x">
|
||||
<term><command>a2x</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
is a toolchain manager for AsciiDoc
|
||||
(converts Asciidoc text files to other file formats)
|
||||
</para>
|
||||
<indexterm zone="asciidoc a2x">
|
||||
<primary sortas="b-a2x">a2x</primary>
|
||||
</indexterm>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry id="asciidoc-prog">
|
||||
<term><command>asciidoc</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
converts an AsciiDoc text file to HTML or DocBook
|
||||
</para>
|
||||
<indexterm zone="asciidoc asciidoc-prog">
|
||||
<primary sortas="b-asciidoc-prog">asciidoc</primary>
|
||||
</indexterm>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</sect3>
|
||||
|
||||
</sect2>
|
||||
Loading…
Reference in New Issue
Block a user