mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-26 08:42:12 +08:00
Add the sphinx_rtd_theme python module
This commit is contained in:
parent
6e98a0804b
commit
6e86a833af
@ -198,6 +198,11 @@
|
||||
<xref linkend="sphinx"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<xref linkend="sphinx_rtd_theme"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<xref linkend="PyYAML"/>
|
||||
@ -304,4 +309,7 @@
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
href="python-modules/sphinx.xml"/>
|
||||
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
href="python-modules/sphinx_rtd_theme.xml"/>
|
||||
|
||||
</sect1>
|
||||
|
145
general/prog/python-modules/sphinx_rtd_theme.xml
Normal file
145
general/prog/python-modules/sphinx_rtd_theme.xml
Normal file
@ -0,0 +1,145 @@
|
||||
<?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_rtd_theme-download-http "https://files.pythonhosted.org/packages/source/s/sphinx_rtd_theme/sphinx_rtd_theme-&sphinx_rtd_theme-version;.tar.gz">
|
||||
<!ENTITY sphinx_rtd_theme-download-ftp " ">
|
||||
<!ENTITY sphinx_rtd_theme-md5sum "fdfc7d2e102cb96eca0f6155dde7403e">
|
||||
<!ENTITY sphinx_rtd_theme-size "2.7 MB">
|
||||
<!ENTITY sphinx_rtd_theme-buildsize "2.6 MB">
|
||||
<!ENTITY sphinx_rtd_theme-time "less than 0.1 SBU">
|
||||
]>
|
||||
|
||||
<sect2 id="sphinx_rtd_theme" xreflabel="sphinx_rtd_theme-&sphinx_rtd_theme-version;">
|
||||
|
||||
<title>Sphinx_rtd_theme-&sphinx_rtd_theme-version;</title>
|
||||
|
||||
<indexterm zone="sphinx_rtd_theme">
|
||||
<primary sortas="a-sphinx_rtd_theme">sphinx_rtd_theme</primary>
|
||||
</indexterm>
|
||||
|
||||
<sect3 role="package">
|
||||
<title>Introduction to Sphinx_rtd_theme Module</title>
|
||||
|
||||
<para>
|
||||
The <application>sphinx_rtd_theme</application> module is a Sphinx
|
||||
theme designed to provide a great reader experience for documentation
|
||||
users on both desktop and mobile devices. This theme is used primarily
|
||||
on Read the Docs but can work with any Sphinx project.
|
||||
</para>
|
||||
|
||||
&lfs112_checked;
|
||||
|
||||
<bridgehead renderas="sect4">Package Information</bridgehead>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>
|
||||
Download (HTTP): <ulink url="&sphinx_rtd_theme-download-http;"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Download (FTP): <ulink url="&sphinx_rtd_theme-download-ftp;"/>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Download MD5 sum: &sphinx_rtd_theme-md5sum;
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Download size: &sphinx_rtd_theme-size;
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Estimated disk space required: &sphinx_rtd_theme-buildsize;
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Estimated build time: &sphinx_rtd_theme-time;
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<bridgehead renderas="sect4">Sphinx_rtd_theme Dependencies</bridgehead>
|
||||
|
||||
<bridgehead renderas="sect5">Required</bridgehead>
|
||||
<para role="required">
|
||||
<xref linkend="sphinx"/>
|
||||
</para>
|
||||
|
||||
<bridgehead renderas="sect5">Optional (for tests)</bridgehead>
|
||||
<para role="optional">
|
||||
<xref linkend="pytest"/> and
|
||||
<ulink url="https://pypi.org/project/readthedocs-sphinx-ext">
|
||||
readthedocs-sphinx-ext
|
||||
</ulink>
|
||||
</para>
|
||||
|
||||
</sect3>
|
||||
|
||||
<sect3 role="installation">
|
||||
<title>Installation of Sphinx_rtd_theme</title>
|
||||
<!-- Upstream tentative fix: not completely tested, it seems
|
||||
but otherwise we fall into dependency hell -->
|
||||
<para>
|
||||
Fix a wrong version for a dependency list:
|
||||
</para>
|
||||
|
||||
<screen><userinput>sed -i s/0.18/0.20/ setup.py</userinput></screen>
|
||||
|
||||
<para>
|
||||
Build the module:
|
||||
</para>
|
||||
|
||||
<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
||||
|
||||
<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 sphinx_rtd_theme</userinput></screen>
|
||||
|
||||
<para>
|
||||
Assuming <xref linkend="pytest"/> is
|
||||
installed, but the other optional dependency is not, the installation
|
||||
can be tested with the following commands:
|
||||
</para>
|
||||
|
||||
<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
||||
source testenv/bin/activate &&
|
||||
pip3 install readthedocs-sphinx-ext &&
|
||||
python3 /usr/bin/pytest<!-- no && because of a possible error -->
|
||||
deactivate</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>None</seg>
|
||||
<seg>None</seg>
|
||||
<seg>
|
||||
/usr/lib/python&python3-majorver;/site-packages/sphinx_rtd_theme and
|
||||
/usr/lib/python&python3-majorver;/site-packages/sphinx_rtd_theme-&sphinx_rtd_theme-version;.dist-info
|
||||
</seg>
|
||||
</seglistitem>
|
||||
</segmentedlist>
|
||||
|
||||
</sect3>
|
||||
|
||||
</sect2>
|
@ -529,6 +529,7 @@ to avoid building libxml2 twice, which is slow with all deps -->
|
||||
<!ENTITY scour-version "0.38.2">
|
||||
<!ENTITY six-version "1.16.0">
|
||||
<!ENTITY sphinx-version "5.2.2">
|
||||
<!ENTITY sphinx_rtd_theme-version "1.0.0">
|
||||
<!ENTITY PyYAML-version "6.0">
|
||||
|
||||
<!-- Python module versions used in the Python Dependencies instructions -->
|
||||
|
Loading…
Reference in New Issue
Block a user