Update documentation about shiboken and remove old one about
boost.python.
Reviewer: Lauro Moura <lauro.neto@openbossa.org>
Luciano Wolf <luciano.wolf@openbossa.org>
This commit is contained in:
parent
8d0fc00e8b
commit
35a3178fdc
7 changed files with 60 additions and 23 deletions
|
|
@ -7,7 +7,7 @@ Pre-requisites
|
||||||
You will need:
|
You will need:
|
||||||
|
|
||||||
1. Qt4 source code (for API documentation).
|
1. Qt4 source code (for API documentation).
|
||||||
2. boostpythongenerator
|
2. Generator runner with shiboken plugin
|
||||||
3. PySide source code
|
3. PySide source code
|
||||||
4. cmake
|
4. cmake
|
||||||
5. sphinx
|
5. sphinx
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@ Contents:
|
||||||
cmake-primer
|
cmake-primer
|
||||||
setup-apiextractor
|
setup-apiextractor
|
||||||
setup-generator
|
setup-generator
|
||||||
setup-boostpython
|
shiboken
|
||||||
setup-bindings
|
setup-bindings
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -24,7 +24,6 @@ Build requirements
|
||||||
|
|
||||||
+ CMake >= 2.6.0
|
+ CMake >= 2.6.0
|
||||||
+ Qt4.5 libraries and development headers >= 4.5.0
|
+ Qt4.5 libraries and development headers >= 4.5.0
|
||||||
+ libboost-graph >= 1.38.0
|
|
||||||
|
|
||||||
Building and installing
|
Building and installing
|
||||||
=======================
|
=======================
|
||||||
|
|
@ -41,7 +40,6 @@ following packages are installed:
|
||||||
* debhelper (>= 5)
|
* debhelper (>= 5)
|
||||||
* cdbs
|
* cdbs
|
||||||
* cmake (>= 2.6.0)
|
* cmake (>= 2.6.0)
|
||||||
* libboost-graph1.38-dev (>= 1.38.0)
|
|
||||||
* libqt4-dev (>= 4.5)
|
* libqt4-dev (>= 4.5)
|
||||||
|
|
||||||
And then you can build the package using::
|
And then you can build the package using::
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ making them available just using the ``import`` command.
|
||||||
|
|
||||||
The build process is comprised of two stages: in a first moment the
|
The build process is comprised of two stages: in a first moment the
|
||||||
bindings source code are created from the Qt 4.6 headers by calling
|
bindings source code are created from the Qt 4.6 headers by calling
|
||||||
the :ref:`boost-python-generator` with apropriate parameters; the
|
the :ref:`generator-runner` with apropriate parameters; the
|
||||||
generated files are then compiled and linked together to form the
|
generated files are then compiled and linked together to form the
|
||||||
bindings libraries.
|
bindings libraries.
|
||||||
|
|
||||||
|
|
@ -41,8 +41,9 @@ Build requirements
|
||||||
|
|
||||||
+ CMake (>= 2.6.0)
|
+ CMake (>= 2.6.0)
|
||||||
+ Qt 4.6 libraries + headers
|
+ Qt 4.6 libraries + headers
|
||||||
+ Boost.Python + headers (>= 1.40.0)
|
+ Python dev libraries
|
||||||
+ :ref:`boost-python-generator`
|
+ Shiboken libraries
|
||||||
|
+ :ref:`generator-runner`
|
||||||
|
|
||||||
|
|
||||||
Building and installing
|
Building and installing
|
||||||
|
|
@ -67,8 +68,7 @@ following packages are installed:
|
||||||
* cmake (>= 2.6.0)
|
* cmake (>= 2.6.0)
|
||||||
* python-all-dev
|
* python-all-dev
|
||||||
* python-central (>= 0.6)
|
* python-central (>= 0.6)
|
||||||
* boostpythongenerator (>= 0.3)
|
* generatorrunner (>= 0.4)
|
||||||
* libboost-python1.40-dev (>= 1.40.0)
|
|
||||||
* libqt4-dev (>= 4.5)
|
* libqt4-dev (>= 4.5)
|
||||||
|
|
||||||
And then you can build the package using::
|
And then you can build the package using::
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ Overview
|
||||||
The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the
|
The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the
|
||||||
program that controls the binding generation process according to the
|
program that controls the binding generation process according to the
|
||||||
rules given by the user through headers, type system files and generator
|
rules given by the user through headers, type system files and generator
|
||||||
front-ends (such as :ref:`boost-python-generator`). It depends on
|
front-ends (such as :ref:`shiboken-generator`). It depends on
|
||||||
:ref:`api-extractor` library.
|
:ref:`api-extractor` library.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
51
doc/howto-build/shiboken.rst
Normal file
51
doc/howto-build/shiboken.rst
Normal file
|
|
@ -0,0 +1,51 @@
|
||||||
|
|
||||||
|
.. _shiboken-generator:
|
||||||
|
|
||||||
|
******************
|
||||||
|
Shiboken Generator
|
||||||
|
******************
|
||||||
|
|
||||||
|
Overview
|
||||||
|
=========================================
|
||||||
|
|
||||||
|
The **Shiboken Generator** (A.K.A. :program:`shiboken`) is
|
||||||
|
the plugin that creates the PySide bindings source files from Qt headers
|
||||||
|
and auxiliary files (typesystems, ``global.h`` and glue files). It depends on
|
||||||
|
:ref:`generator-runner` and :ref:`api-extractor` library.
|
||||||
|
|
||||||
|
|
||||||
|
Getting the sources
|
||||||
|
===================
|
||||||
|
|
||||||
|
* Download URL: http://www.pyside.org/downloads/
|
||||||
|
|
||||||
|
Build requirements
|
||||||
|
==================
|
||||||
|
|
||||||
|
+ CMake >= 2.6.0
|
||||||
|
+ Qt libraries and development headers >= 4.5.0
|
||||||
|
+ :ref:`api-extractor` + development headers
|
||||||
|
+ :ref:`generator-runner` + 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.3.2)
|
||||||
|
* libgenrunner-dev (>= 0.3.2a1)
|
||||||
|
|
||||||
|
And then you can build the package using::
|
||||||
|
|
||||||
|
$ dpkg-buildpackage -rfakeroot
|
||||||
|
|
@ -1,8 +1,7 @@
|
||||||
PySide issues and specificities
|
PySide issues and specificities
|
||||||
*******************************
|
*******************************
|
||||||
|
|
||||||
This document shows some points not supported yet by Boost.python
|
This document shows some points not supported by PySide.
|
||||||
and PySide.
|
|
||||||
|
|
||||||
Deprecated Methods
|
Deprecated Methods
|
||||||
------------------
|
------------------
|
||||||
|
|
@ -13,14 +12,3 @@ e.g.: `QColor.dark()` and `QColor.light()`.
|
||||||
**How to solve:** update the methods with new ones like `QColor.darker()`
|
**How to solve:** update the methods with new ones like `QColor.darker()`
|
||||||
and `QColor.lighter()`.
|
and `QColor.lighter()`.
|
||||||
|
|
||||||
Class methods with static and normal methods with the same signature
|
|
||||||
--------------------------------------------------------------------
|
|
||||||
|
|
||||||
Boost.Python does not support static methods and member methods
|
|
||||||
with the same signature. The static versions is renamed to
|
|
||||||
*classMethodName*.
|
|
||||||
|
|
||||||
**Example:** QFile.permissions() and QFile.permissions(QString)
|
|
||||||
|
|
||||||
**How to solve:** for static methods use QFile.filePermissions(QString)
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue