diff options
author | Renato Filho <renato.filho@openbossa.org> | 2010-04-28 14:37:39 -0300 |
---|---|---|
committer | Renato Filho <renato.filho@openbossa.org> | 2010-04-28 16:36:47 -0300 |
commit | 35a3178fdcb0b3e925491ac33b1f3ed02ced7725 (patch) | |
tree | 80fba94c6a7982e179d8f453755d5d838d31532f /doc | |
parent | 8d0fc00e8bbcb504373c3b29932bc6bdc2fb9fe3 (diff) |
Update documentation about shiboken and remove old one about
boost.python.
Reviewer: Lauro Moura <lauro.neto@openbossa.org>
Luciano Wolf <luciano.wolf@openbossa.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/generatingdocs.rst | 2 | ||||
-rw-r--r-- | doc/howto-build/index.rst | 2 | ||||
-rw-r--r-- | doc/howto-build/setup-apiextractor.rst | 2 | ||||
-rw-r--r-- | doc/howto-build/setup-bindings.rst | 10 | ||||
-rw-r--r-- | doc/howto-build/setup-generator.rst | 2 | ||||
-rw-r--r-- | doc/howto-build/shiboken.rst | 51 | ||||
-rw-r--r-- | doc/issuesdiff.rst | 14 |
7 files changed, 60 insertions, 23 deletions
diff --git a/doc/generatingdocs.rst b/doc/generatingdocs.rst index 7d33cb817..1423aab47 100644 --- a/doc/generatingdocs.rst +++ b/doc/generatingdocs.rst @@ -7,7 +7,7 @@ Pre-requisites You will need: 1. Qt4 source code (for API documentation). -2. boostpythongenerator +2. Generator runner with shiboken plugin 3. PySide source code 4. cmake 5. sphinx diff --git a/doc/howto-build/index.rst b/doc/howto-build/index.rst index 986dba505..e8d1cd100 100644 --- a/doc/howto-build/index.rst +++ b/doc/howto-build/index.rst @@ -13,7 +13,7 @@ Contents: cmake-primer setup-apiextractor setup-generator - setup-boostpython + shiboken setup-bindings diff --git a/doc/howto-build/setup-apiextractor.rst b/doc/howto-build/setup-apiextractor.rst index 3a662337a..63aa8ec69 100644 --- a/doc/howto-build/setup-apiextractor.rst +++ b/doc/howto-build/setup-apiextractor.rst @@ -24,7 +24,6 @@ Build requirements + CMake >= 2.6.0 + Qt4.5 libraries and development headers >= 4.5.0 -+ libboost-graph >= 1.38.0 Building and installing ======================= @@ -41,7 +40,6 @@ 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:: diff --git a/doc/howto-build/setup-bindings.rst b/doc/howto-build/setup-bindings.rst index 9e574cde5..3e31b7ce4 100644 --- a/doc/howto-build/setup-bindings.rst +++ b/doc/howto-build/setup-bindings.rst @@ -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 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 bindings libraries. @@ -41,8 +41,9 @@ Build requirements + CMake (>= 2.6.0) + Qt 4.6 libraries + headers - + Boost.Python + headers (>= 1.40.0) - + :ref:`boost-python-generator` + + Python dev libraries + + Shiboken libraries + + :ref:`generator-runner` Building and installing @@ -67,8 +68,7 @@ following packages are installed: * cmake (>= 2.6.0) * python-all-dev * python-central (>= 0.6) -* boostpythongenerator (>= 0.3) -* libboost-python1.40-dev (>= 1.40.0) +* generatorrunner (>= 0.4) * libqt4-dev (>= 4.5) And then you can build the package using:: diff --git a/doc/howto-build/setup-generator.rst b/doc/howto-build/setup-generator.rst index c3f321c3c..a0b4090ee 100644 --- a/doc/howto-build/setup-generator.rst +++ b/doc/howto-build/setup-generator.rst @@ -11,7 +11,7 @@ Overview The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the program that controls the binding generation process according to the 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. diff --git a/doc/howto-build/shiboken.rst b/doc/howto-build/shiboken.rst new file mode 100644 index 000000000..c4f059b43 --- /dev/null +++ b/doc/howto-build/shiboken.rst @@ -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 diff --git a/doc/issuesdiff.rst b/doc/issuesdiff.rst index 480ad6c8c..4c472aea1 100644 --- a/doc/issuesdiff.rst +++ b/doc/issuesdiff.rst @@ -1,8 +1,7 @@ PySide issues and specificities ******************************* -This document shows some points not supported yet by Boost.python -and PySide. +This document shows some points not supported by PySide. 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()` 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) - |