mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-02-04 15:37:16 +08:00
569925c77f
Move the pythonhoted page to python_modules even though it is not yet activated to render in the book. Change location of pythonhosted md5sum ENTITIES to packages.ent so they can be used in multiple pages but only need to be updated in one place. Note that pages not have entries like: <!ENTITY asciidoc-md5sum "&asciidoc-md5sum;"> so this seems to be redefinig the entity to the version in packages.ent. This seems to be OK with the build system.
149 lines
4.2 KiB
XML
149 lines
4.2 KiB
XML
<?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 doxyqml-download-http "https://files.pythonhosted.org/packages/source/d/doxyqml/doxyqml-&doxyqml-version;.tar.gz">
|
|
<!ENTITY doxyqml-download-ftp " ">
|
|
<!ENTITY doxyqml-md5sum "&doxyqml-md5sum;">
|
|
<!ENTITY doxyqml-size "28 KB">
|
|
<!ENTITY doxyqml-buildsize "600 KB (with tests)">
|
|
<!ENTITY doxyqml-time "less than 0.1 SBU (with tests)">
|
|
]>
|
|
|
|
<sect2 id="doxyqml" xreflabel="doxyqml-&doxyqml-version;">
|
|
|
|
<title>Doxyqml-&doxyqml-version;</title>
|
|
|
|
<indexterm zone="doxyqml">
|
|
<primary sortas="a-doxyqml">doxyqml</primary>
|
|
</indexterm>
|
|
|
|
<sect3 role="package">
|
|
<title>Introduction to Doxyqml Module</title>
|
|
|
|
<para>
|
|
The <application>Doxyqml</application> package allows using Doxygen
|
|
to document QML classes.
|
|
</para>
|
|
|
|
&lfs112_checked;
|
|
|
|
<bridgehead renderas="sect4">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>
|
|
Download (HTTP): <ulink url="&doxyqml-download-http;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download (FTP): <ulink url="&doxyqml-download-ftp;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download MD5 sum: &doxyqml-md5sum;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download size: &doxyqml-size;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated disk space required: &doxyqml-buildsize;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated build time: &doxyqml-time;
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect4">Doxyqml Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect5">Required (Run Time)</bridgehead>
|
|
<para role="required">
|
|
<xref role="runtime" linkend="doxygen"/>
|
|
</para>
|
|
|
|
<bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
|
<para role="optional">
|
|
<xref linkend="pytest"/>
|
|
</para>
|
|
|
|
</sect3>
|
|
|
|
<sect3 role="installation">
|
|
<title>Installation of Doxyqml</title>
|
|
|
|
<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 doxyqml</userinput></screen>
|
|
|
|
<para>
|
|
To test the installation, run:
|
|
</para>
|
|
|
|
<screen remap="test"><userinput>pytest</userinput></screen>
|
|
|
|
<para>
|
|
The <emphasis>test_qmlclass.py</emphasis> test is known to fail.
|
|
</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>doxyqml</seg>
|
|
<seg>None</seg>
|
|
<seg>
|
|
/usr/lib/python&python3-majorver;/site-packages/doxyqml and
|
|
/usr/lib/python&python3-majorver;/site-packages/doxyqml-&doxyqml-version;.dist-info
|
|
</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="doxyqml-prog">
|
|
<term><command>doxyqml</command></term>
|
|
<listitem>
|
|
<para>
|
|
is a Doxygen input filter for QML files.
|
|
</para>
|
|
<indexterm zone="doxyqml doxyqml-prog">
|
|
<primary sortas="b-doxyqml-prog">doxyqml</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect3>
|
|
|
|
</sect2>
|