glfs/general/prog/python-modules/doxypypy.xml
2024-01-19 22:39:35 +01:00

140 lines
3.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!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 doxypypy-download-http "https://files.pythonhosted.org/packages/source/d/doxypypy/doxypypy-&doxypypy-version;.tar.gz">
<!ENTITY doxypypy-download-ftp " ">
<!ENTITY doxypypy-md5sum "&doxypypy-md5sum;">
<!ENTITY doxypypy-size "45 KB">
<!ENTITY doxypypy-buildsize "2.1 MB">
<!ENTITY doxypypy-time "less than 0.1 SBU">
]>
<sect2 id="doxypypy" xreflabel="doxypypy-&doxypypy-version;">
<title>Doxypypy-&doxypypy-version;</title>
<indexterm zone="doxypypy">
<primary sortas="a-doxypypy">doxypypy</primary>
</indexterm>
<sect3 role="package">
<title>Introduction to Doxypypy Module</title>
<para>
The <application>Doxypypy</application> package is a doxygen filter
for python.
</para>
&lfs120_checked;
<bridgehead renderas="sect4">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&doxypypy-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&doxypypy-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &doxypypy-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &doxypypy-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &doxypypy-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &doxypypy-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect4">Doxypypy Dependencies</bridgehead>
<bridgehead renderas="sect5">Required</bridgehead>
<para role="required">
<xref linkend="chardet"/> and
<xref role="runtime" linkend="doxygen"/> (at run time)
</para>
</sect3>
<sect3 role="installation">
<title>Installation of Doxypypy</title>
<para> Build the module: </para>
&build-wheel;
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>&install-wheel; doxypypy</userinput></screen>
<para>
This package does not come with a working test suite.
</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>doxypypy</seg>
<seg>None</seg>
<seg>
/usr/lib/python&python3-majorver;/site-packages/doxypypy and
/usr/lib/python&python3-majorver;/site-packages/doxypypy-&doxypypy-version;.dist-info
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect5">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="doxypypy-prog">
<term><command>doxypypy</command></term>
<listitem>
<para>
filters Python code for use with Doxygen, using a syntax-aware
approach.
</para>
<indexterm zone="doxypypy doxypypy-prog">
<primary sortas="b-doxypypy-prog">doxypypy</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>