[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[622cc86e] | 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 doxypypy-download-http "https://files.pythonhosted.org/packages/source/d/doxypypy/doxypypy-&doxypypy-version;.tar.gz">
|
---|
| 8 | <!ENTITY doxypypy-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY doxypypy-md5sum "&doxypypy-md5sum;">
|
---|
[30090b7] | 10 | <!ENTITY doxypypy-size "45 KB">
|
---|
| 11 | <!ENTITY doxypypy-buildsize "2.1 MB">
|
---|
[622cc86e] | 12 | <!ENTITY doxypypy-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="doxypypy" xreflabel="doxypypy-&doxypypy-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Doxypypy-&doxypypy-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="doxypypy">
|
---|
| 20 | <primary sortas="a-doxypypy">doxypypy</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Doxypypy Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>Doxypypy</application> package is a doxygen filter
|
---|
| 28 | for python.
|
---|
| 29 | </para>
|
---|
| 30 |
|
---|
[f822342] | 31 | &lfs122_checked;
|
---|
[622cc86e] | 32 |
|
---|
| 33 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>
|
---|
| 37 | Download (HTTP): <ulink url="&doxypypy-download-http;"/>
|
---|
| 38 | </para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (FTP): <ulink url="&doxypypy-download-ftp;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download MD5 sum: &doxypypy-md5sum;
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download size: &doxypypy-size;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Estimated disk space required: &doxypypy-buildsize;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated build time: &doxypypy-time;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
| 66 |
|
---|
| 67 | <bridgehead renderas="sect4">Doxypypy Dependencies</bridgehead>
|
---|
| 68 |
|
---|
[30090b7] | 69 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
[622cc86e] | 70 | <para role="required">
|
---|
[30090b7] | 71 | <xref linkend="chardet"/> and
|
---|
| 72 | <xref role="runtime" linkend="doxygen"/> (at run time)
|
---|
[622cc86e] | 73 | </para>
|
---|
| 74 |
|
---|
| 75 | </sect3>
|
---|
| 76 |
|
---|
| 77 | <sect3 role="installation">
|
---|
| 78 | <title>Installation of Doxypypy</title>
|
---|
| 79 |
|
---|
| 80 | <para> Build the module: </para>
|
---|
| 81 |
|
---|
[db244ae2] | 82 | &build-wheel;
|
---|
[622cc86e] | 83 |
|
---|
| 84 | <para>
|
---|
| 85 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 86 | </para>
|
---|
| 87 |
|
---|
[db244ae2] | 88 | <screen role="root"><userinput>&install-wheel; doxypypy</userinput></screen>
|
---|
[622cc86e] | 89 |
|
---|
| 90 | <para>
|
---|
| 91 | This package does not come with a working test suite.
|
---|
| 92 | </para>
|
---|
| 93 |
|
---|
| 94 | </sect3>
|
---|
| 95 |
|
---|
| 96 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 97 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 98 |
|
---|
| 99 | <sect3 role="content">
|
---|
| 100 | <title>Contents</title>
|
---|
| 101 |
|
---|
| 102 | <segmentedlist>
|
---|
| 103 | <segtitle>Installed Programs</segtitle>
|
---|
| 104 | <segtitle>Installed Libraries</segtitle>
|
---|
| 105 | <segtitle>Installed Directories</segtitle>
|
---|
| 106 |
|
---|
| 107 | <seglistitem>
|
---|
| 108 | <seg>doxypypy</seg>
|
---|
| 109 | <seg>None</seg>
|
---|
| 110 | <seg>
|
---|
| 111 | /usr/lib/python&python3-majorver;/site-packages/doxypypy and
|
---|
| 112 | /usr/lib/python&python3-majorver;/site-packages/doxypypy-&doxypypy-version;.dist-info
|
---|
| 113 | </seg>
|
---|
| 114 | </seglistitem>
|
---|
| 115 | </segmentedlist>
|
---|
| 116 |
|
---|
| 117 | <variablelist>
|
---|
| 118 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 119 | <?dbfo list-presentation="list"?>
|
---|
| 120 | <?dbhtml list-presentation="table"?>
|
---|
| 121 |
|
---|
| 122 | <varlistentry id="doxypypy-prog">
|
---|
| 123 | <term><command>doxypypy</command></term>
|
---|
| 124 | <listitem>
|
---|
| 125 | <para>
|
---|
| 126 | filters Python code for use with Doxygen, using a syntax-aware
|
---|
| 127 | approach.
|
---|
| 128 | </para>
|
---|
| 129 | <indexterm zone="doxypypy doxypypy-prog">
|
---|
| 130 | <primary sortas="b-doxypypy-prog">doxypypy</primary>
|
---|
| 131 | </indexterm>
|
---|
| 132 | </listitem>
|
---|
| 133 | </varlistentry>
|
---|
| 134 |
|
---|
| 135 | </variablelist>
|
---|
| 136 |
|
---|
| 137 | </sect3>
|
---|
| 138 |
|
---|
| 139 | </sect2>
|
---|