source: general/prog/python-dependencies/sphinxcontrib-serializinghtml.xml@ a2da666

<?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 sc-serializinghtml-download-http "https://files.pythonhosted.org/packages/source/s/sphinxcontrib_serializinghtml/sphinxcontrib_serializinghtml-&sc-serializinghtml-version;.tar.gz">
  <!ENTITY sc-serializinghtml-download-ftp  " ">
  <!ENTITY sc-serializinghtml-md5sum        "&sc-serializinghtml-md5sum;">
  <!ENTITY sc-serializinghtml-size          "15 KB">
  <!ENTITY sc-serializinghtml-buildsize     "2.0 MB (with tests)">
  <!ENTITY sc-serializinghtml-time          "less than 0.1 SBU (with tests)">
]>

  <sect2 id="sc-serializinghtml" xreflabel="sphinxcontrib-serializinghtml-&sc-serializinghtml-version;">

    <title>Sphinxcontrib-serializinghtml-&sc-serializinghtml-version;</title>

    <indexterm zone="sc-serializinghtml">
      <primary sortas="a-sphinxcontrib-serializinghtml">sphinxcontrib-serializinghtml</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Sphinxcontrib-serializinghtml Module</title>

      <para>
        The <application>Sphinxcontrib-serializinghtml</application> package is a
        <application>Sphinx</application> extension which outputs
        <quote>serialized</quote> HTML files (json and pickle).
      </para>

      &lfs120_checked;

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&sc-serializinghtml-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download (FTP): <ulink url="&sc-serializinghtml-download-ftp;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &sc-serializinghtml-md5sum;
          </para>
        </listitem>
        <listitem>
          <para>
            Download size: &sc-serializinghtml-size;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated disk space required: &sc-serializinghtml-buildsize;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated build time: &sc-serializinghtml-time;
          </para>
        </listitem>
      </itemizedlist>

      <bridgehead renderas="sect4">Sphinxcontrib-serializinghtml Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="sphinx"/> 
      </para>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/> and
        <xref linkend="sphinx"/> (circular dependency)
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Sphinxcontrib-serializinghtml</title>

      <para>
        First remove a spurious circular dependency:
      </para>

<screen><userinput>sed /^dependencies/,+2d -i pyproject.toml</userinput></screen>

      <para> Build the module: </para>

&build-wheel;

      <para>
        Now, as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>&install-wheel; sphinxcontrib-serializinghtml</userinput></screen>

      <para>
        To test the installation, first install <xref linkend="sphinx"/>, then
        run <command>pytest</command>.
      </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/sphinxcontrib and
            /usr/lib/python&python3-majorver;/site-packages/sphinxcontrib_serializinghtml-&sc-serializinghtml-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>