summaryrefslogtreecommitdiffstats
path: root/doc/compiling/setup-apiextractor.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/compiling/setup-apiextractor.rst')
-rw-r--r--doc/compiling/setup-apiextractor.rst56
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/compiling/setup-apiextractor.rst b/doc/compiling/setup-apiextractor.rst
new file mode 100644
index 00000000..68c162f8
--- /dev/null
+++ b/doc/compiling/setup-apiextractor.rst
@@ -0,0 +1,56 @@
+
+.. _api-extractor:
+
+**************
+API Extractor
+**************
+
+Overview
+========
+
+The **API Extractor** library is used by the binding generator to
+parse the header and typesystem files to create an internal
+representation of the API. It is based on the QtScriptGenerator
+codebase.
+
+Getting the sources
+===================
+
+.. todo::
+ Replace with the OSS project repo info
+
+* Git URL: https://dvcs.projects.maemo.org/git/python/apiextractor
+* Web interface: https://dvcs.projects.maemo.org/git/?p=python/apiextractor
+
+To checkout the most updated version, use the following command::
+
+ $ git clone https://dvcs.projects.maemo.org/git/python/apiextractor/
+
+Build requirements
+==================
+
+* Qt4.5 development headers and libraries >= 4.5.0
+* libboost-graph >= 1.38.0
+* cmake >= 2.6.0
+
+Building and installing
+=======================
+
+To build and install just follow the generic cmake instructions in section
+:ref:`cmake-primer`.
+
+Debian packaging
+================
+
+In order to compile this package in a debian environment, make sure the
+following packages are installed:
+
+* debhelper (>= 5)
+* cdbs
+* cmake (>= 2.6.0)
+* libboost-graph1.38-dev (>= 1.38.0)
+* libqt4-dev (>= 4.5)
+
+And then you can build the package using::
+
+ $ dpkg-buildpackage -rfakeroot