1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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_rtd_theme-download-http "https://files.pythonhosted.org/packages/source/s/sphinx_rtd_theme/sphinx_rtd_theme-&sphinx_rtd_theme-version;.tar.gz">
|
---|
8 | <!ENTITY sphinx_rtd_theme-download-ftp " ">
|
---|
9 | <!ENTITY sphinx_rtd_theme-md5sum "&sphinx_rtd_theme-md5sum;">
|
---|
10 | <!ENTITY sphinx_rtd_theme-size "2.7 MB">
|
---|
11 | <!ENTITY sphinx_rtd_theme-buildsize "36 MB (with tests)">
|
---|
12 | <!ENTITY sphinx_rtd_theme-time "0.1 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect2 id="sphinx_rtd_theme" xreflabel="sphinx_rtd_theme-&sphinx_rtd_theme-version;">
|
---|
16 |
|
---|
17 | <title>Sphinx_rtd_theme-&sphinx_rtd_theme-version;</title>
|
---|
18 |
|
---|
19 | <indexterm zone="sphinx_rtd_theme">
|
---|
20 | <primary sortas="a-sphinx_rtd_theme">sphinx_rtd_theme</primary>
|
---|
21 | </indexterm>
|
---|
22 |
|
---|
23 | <sect3 role="package">
|
---|
24 | <title>Introduction to Sphinx_rtd_theme Module</title>
|
---|
25 |
|
---|
26 | <para>
|
---|
27 | The <application>sphinx_rtd_theme</application> module is a Sphinx
|
---|
28 | theme designed to provide a great reader experience for documentation
|
---|
29 | users on both desktop and mobile devices. This theme is used primarily
|
---|
30 | on Read the Docs but can work with any Sphinx project.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs122_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&sphinx_rtd_theme-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&sphinx_rtd_theme-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &sphinx_rtd_theme-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &sphinx_rtd_theme-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &sphinx_rtd_theme-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &sphinx_rtd_theme-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect4">Sphinx_rtd_theme Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
72 | <para role="required">
|
---|
73 | <xref linkend="sphinx"/> and
|
---|
74 | <xref linkend="sc-jquery"/>
|
---|
75 | </para>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect5">Optional (for tests)</bridgehead>
|
---|
78 | <para role="optional">
|
---|
79 | <xref linkend="pytest"/> and
|
---|
80 | <ulink url="https://pypi.org/project/readthedocs-sphinx-ext">
|
---|
81 | readthedocs-sphinx-ext
|
---|
82 | </ulink>
|
---|
83 | </para>
|
---|
84 |
|
---|
85 | </sect3>
|
---|
86 |
|
---|
87 | <sect3 role="installation">
|
---|
88 | <title>Installation of Sphinx_rtd_theme</title>
|
---|
89 |
|
---|
90 | <para>
|
---|
91 | First, tell the package that newer <xref linkend="docutils"/> and
|
---|
92 | <xref linkend="sphinx"/> versions are safe to use:
|
---|
93 | </para>
|
---|
94 |
|
---|
95 | <screen><userinput>sed -e 's/0.21/0.22/' \
|
---|
96 | -e 's/8$/9/' \
|
---|
97 | -i setup.cfg</userinput></screen>
|
---|
98 |
|
---|
99 | <para>
|
---|
100 | Build the module:
|
---|
101 | </para>
|
---|
102 |
|
---|
103 | &build-wheel;
|
---|
104 |
|
---|
105 | <para>
|
---|
106 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <screen role="root"><userinput>&install-wheel; sphinx_rtd_theme</userinput></screen>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | Assuming <xref linkend="pytest"/> is
|
---|
113 | installed, but the other optional dependency is not, the installation
|
---|
114 | can be tested with the following commands:
|
---|
115 | </para>
|
---|
116 |
|
---|
117 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
118 | source testenv/bin/activate &&
|
---|
119 | pip3 install readthedocs-sphinx-ext &&
|
---|
120 | python3 /usr/bin/pytest<!-- no && because of a possible error -->
|
---|
121 | deactivate</userinput></screen>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | Several tests return warnings because they use a deprecated sphinx API.
|
---|
125 | </para>
|
---|
126 |
|
---|
127 | </sect3>
|
---|
128 |
|
---|
129 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
130 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
131 |
|
---|
132 | <sect3 role="content">
|
---|
133 | <title>Contents</title>
|
---|
134 |
|
---|
135 | <segmentedlist>
|
---|
136 | <segtitle>Installed Programs</segtitle>
|
---|
137 | <segtitle>Installed Libraries</segtitle>
|
---|
138 | <segtitle>Installed Directories</segtitle>
|
---|
139 |
|
---|
140 | <seglistitem>
|
---|
141 | <seg>None</seg>
|
---|
142 | <seg>None</seg>
|
---|
143 | <seg>
|
---|
144 | /usr/lib/python&python3-majorver;/site-packages/sphinx_rtd_theme and
|
---|
145 | /usr/lib/python&python3-majorver;/site-packages/sphinx_rtd_theme-&sphinx_rtd_theme-version;.dist-info
|
---|
146 | </seg>
|
---|
147 | </seglistitem>
|
---|
148 | </segmentedlist>
|
---|
149 |
|
---|
150 | </sect3>
|
---|
151 |
|
---|
152 | </sect2>
|
---|