aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/_templates/index.html10
-rw-r--r--doc/compiling/cmake-primer.rst72
-rw-r--r--doc/compiling/compiling.rst9
-rw-r--r--doc/compiling/setup-apiextractor.rst46
-rw-r--r--doc/compiling/setup-generator.rst50
-rw-r--r--doc/contents.rst1
6 files changed, 4 insertions, 184 deletions
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index bc27be91..6a08f891 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -15,14 +15,12 @@
<h2>Documentation</h2>
<table class="contentstable" align="center" style="margin-left: 30px"><tr>
<td width="50%">
- <p class="biglink"><a class="biglink" href="{{ pathto("overview") }}">Overview</a><br/>
- <span class="linkdescr">how generator works</span></p>
- </td>
- <td width="50%">
- <p class="biglink"><a class="biglink" href="{{ pathto("compiling/compiling") }}">Compiling/Installing</a><br/>
- <span class="linkdescr">how to compile and install GeneratorRunner</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br/>
<span class="linkdescr">for a complete overview</span></p>
+ </td>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("overview") }}">Overview</a><br/>
+ <span class="linkdescr">how generator works</span></p>
</td></tr>
</table>
</div>
diff --git a/doc/compiling/cmake-primer.rst b/doc/compiling/cmake-primer.rst
deleted file mode 100644
index 499b8433..00000000
--- a/doc/compiling/cmake-primer.rst
+++ /dev/null
@@ -1,72 +0,0 @@
-
-.. _cmake-primer:
-
-************
-CMake primer
-************
-
-This chapter is a basic introduction to CMake, the build system used by PySide
-and the binding generator runner.
-
-The practical steps will focus on how to use cmake on a Unix-like (GNU/Linux)
-environment.
-
-
-Configuring
-===========
-
-Project file - CMakeLists.txt
------------------------------
-
-CMake parses the file CMakeLists.txt for information about the project,
-like project name, dependencies, what should be compiled, what should be
-shipped.
-
-
-CMake variables
----------------
-
-CMake can have its default behavior modified by providing some
-
-* ``CMAKE_INSTALL_PREFIX=<some path here>`` sets the install prefix to
- the specified path.
-* ``CMAKE_MODULE_PATH=<some path here>`` sets the extra directories
- where CMake will try to find its modules.
-* ``CMAKE_TOOLCHAIN_FILE=<file path>`` sets the path to the file that
- describes the toolchain used to compile this project. It is very useful
- when using CMake with icecc to speedup compilation.
-
-You can define a variable using the ``-D<VARIABLE>`` switch like the example
-below.
-
-* ``-DCMAKE_BUILD_TYPE=Release|Debug`` sets the building behavior. Default
- value is *Release*.
-
-Invoking CMake
---------------
-
-After writing the CMakeLists.txt and deciding which flags will be used,
-you can invoke CMake using::
-
- cmake <CMake flags> <path to toplevel CMakeLists.txt file>
-
-For example, if you use the ``build/`` folder to build the project and
-want it to be installed into ``/opt/sandbox/``, use the following lines::
-
- cd build/
- cmake -DCMAKE_INSTALL_PREFIX=/opt/sandbox ..
-
-CMake will process the project file and write the output files in the
-current directory
-
-Building
-========
-
-After the configuration process, the Makefiles are written and you can build
-the project using :program:`make`.
-
-Installing
-==========
-
-As in the building process, ``make install`` will install the files into
-the target directory.
diff --git a/doc/compiling/compiling.rst b/doc/compiling/compiling.rst
deleted file mode 100644
index 638efa91..00000000
--- a/doc/compiling/compiling.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-Compiling
-*********
-
-.. toctree::
- :maxdepth: 3
-
- cmake-primer
- setup-apiextractor
- setup-generator
diff --git a/doc/compiling/setup-apiextractor.rst b/doc/compiling/setup-apiextractor.rst
deleted file mode 100644
index ea6fb9d9..00000000
--- a/doc/compiling/setup-apiextractor.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-
-.. _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
-===================
-
-* Download URL: http://www.pyside.org/downloads/
-
-Build requirements
-==================
-
-* Qt4.5 development headers and libraries >= 4.5.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)
-* libqt4-dev (>= 4.5)
-
-And then you can build the package using::
-
- $ dpkg-buildpackage -rfakeroot
diff --git a/doc/compiling/setup-generator.rst b/doc/compiling/setup-generator.rst
deleted file mode 100644
index 2118a352..00000000
--- a/doc/compiling/setup-generator.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-
-.. _generatorrunner:
-
-****************
-Generator Runner
-****************
-
-Overview
-=========================================
-
-The **GeneratorRunner** (A.K.A. :program:`generatorrunner`) is
-the program that collects relevant data from C++ headers (paying
-special attention to Qt provided information, like signals and
-properties) and auxiliary files (typesystems, ``global.h`` and
-glue files). For this it relies on the :ref:`api-extractor` library.
-
-
-Getting the sources
-===================
-
-* Download URL: http://www.pyside.org/downloads/
-
-Build requirements
-==================
-
-+ CMake >= 2.6.0
-+ Qt4.5 libraries and development headers >= 4.5.0
-+ :ref:`api-extractor` + development headers
-
-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)
-* libqt4-dev (>= 4.5)
-* libapiextractor-dev (>= 0.1)
-
-And then you can build the package using::
-
- $ dpkg-buildpackage -rfakeroot
diff --git a/doc/contents.rst b/doc/contents.rst
index 5dc94ebc..5abd13bc 100644
--- a/doc/contents.rst
+++ b/doc/contents.rst
@@ -5,4 +5,3 @@ Table of contents
:maxdepth: 3
overview.rst
- compiling/compiling.rst