[afd5400] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 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 |
|
---|
| 8 | <sect1 id="kapidox" xreflabel="kapidox-&kf5-version;">
|
---|
| 9 | <?dbhtml filename="kapidox.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info>
|
---|
| 12 | <othername>$LastChangedBy$</othername>
|
---|
| 13 | <date>$Date$</date>
|
---|
| 14 | </sect1info>
|
---|
| 15 |
|
---|
| 16 | <title>kapidox-&kf5-version;</title>
|
---|
| 17 |
|
---|
| 18 | <indexterm zone="kapidox">
|
---|
| 19 | <primary sortas="a-kapidox">kapidox</primary>
|
---|
| 20 | </indexterm>
|
---|
| 21 |
|
---|
| 22 | <sect2 role="package">
|
---|
| 23 | <title>Introduction to kapidox</title>
|
---|
| 24 |
|
---|
| 25 | <para>
|
---|
| 26 | The <application>kapidox</application> package contains scripts
|
---|
| 27 | and data for building API documentation (dox) in a standard
|
---|
| 28 | format and style.
|
---|
| 29 | </para>
|
---|
| 30 |
|
---|
| 31 | &lfs75_checked;
|
---|
| 32 |
|
---|
| 33 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>
|
---|
| 37 | Download (HTTP): <ulink url="&kapidox-download-http;"/>
|
---|
| 38 | </para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (FTP): <ulink url="&kapidox-download-ftp;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download MD5 sum: &kapidox-md5sum;
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download size: &kapidox-size;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Estimated disk space required: &kapidox-buildsize;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated build time: &kapidox-time;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
| 66 |
|
---|
| 67 | <bridgehead renderas="sect3">kapidox Dependencies</bridgehead>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 70 | <para role="required">
|
---|
| 71 | <xref linkend="cmake"/> and
|
---|
| 72 | <xref linkend="python2"/>
|
---|
| 73 | </para>
|
---|
| 74 |
|
---|
[da6aad1] | 75 | <bridgehead renderas="sect4">Runtime Dependencies</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
| 77 | <xref linkend="doxygen"/>,
|
---|
| 78 | <xref linkend="Jinja2"/>, and
|
---|
| 79 | <xref linkend="PyYAML"/>
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
[afd5400] | 82 | <para condition="html" role="usernotes">
|
---|
| 83 | User Notes: <ulink url="&blfs-wiki;/kapidox"/>
|
---|
| 84 | </para>
|
---|
| 85 | </sect2>
|
---|
| 86 |
|
---|
| 87 | <sect2 role="installation">
|
---|
| 88 | <title>Installation of kapidox</title>
|
---|
| 89 |
|
---|
| 90 | <para>
|
---|
| 91 | Install <application>kapidox</application> by running the following
|
---|
| 92 | commands:
|
---|
| 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <screen><userinput>mkdir build &&
|
---|
| 96 | cd build &&
|
---|
| 97 |
|
---|
| 98 | cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX .. &&
|
---|
| 99 | make</userinput></screen>
|
---|
| 100 |
|
---|
| 101 | <para>
|
---|
| 102 | This package does not come with a test suite.
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <para>
|
---|
| 106 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
| 109 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 110 |
|
---|
| 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="content">
|
---|
| 114 | <title>Contents</title>
|
---|
| 115 |
|
---|
| 116 | <segmentedlist>
|
---|
| 117 | <segtitle>Installed Programs</segtitle>
|
---|
| 118 | <segtitle>Installed Libraries</segtitle>
|
---|
| 119 | <segtitle>Installed Directories</segtitle>
|
---|
| 120 |
|
---|
| 121 | <seglistitem>
|
---|
| 122 | <seg>
|
---|
| 123 | depdiagram-generate, depdiagram-generate-all, depdiagram-prepare,
|
---|
| 124 | kgenapidox kgenframeworksapidox
|
---|
| 125 | </seg>
|
---|
| 126 | <seg>
|
---|
| 127 | None
|
---|
| 128 | </seg>
|
---|
| 129 | <seg>
|
---|
| 130 | $KF5_PREFIX/lib/python-&python2-majorver;/site-packages/kapidox
|
---|
| 131 | </seg>
|
---|
| 132 | </seglistitem>
|
---|
| 133 | </segmentedlist>
|
---|
| 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
| 137 | </sect1>
|
---|