source: general/prog/python-modules/sphinx_rtd_theme.xml@ 569925c7

<?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        "&sphinx_rtd_theme-md5sum;">
  <!ENTITY sphinx_rtd_theme-size          "2.7 MB">
  <!ENTITY sphinx_rtd_theme-buildsize     "14 MB (add 25 MB for tests)">
  <!ENTITY sphinx_rtd_theme-time          "less than 0.1 SBU (with tests)">
]>

  <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 -e s/0.18/0.20/ \
    -e 's/&lt;6/&lt;7/' \
    -i setup.cfg</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 &amp;&amp;
source testenv/bin/activate                    &amp;&amp;
pip3 install readthedocs-sphinx-ext            &amp;&amp;
python3 /usr/bin/pytest<!-- no && because of a possible error -->
deactivate</userinput></screen>

    <para>
      Several tests return a warning because they use a deprecated sphinx API.
    </para>

    </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>