diff options
Diffstat (limited to 'doc/howto-build')
-rw-r--r-- | doc/howto-build/cmake-primer.rst | 72 | ||||
-rw-r--r-- | doc/howto-build/index.rst | 19 | ||||
-rw-r--r-- | doc/howto-build/setup-apiextractor.rst | 52 | ||||
-rw-r--r-- | doc/howto-build/setup-bindings.rst | 82 | ||||
-rw-r--r-- | doc/howto-build/setup-generator.rst | 50 | ||||
-rw-r--r-- | doc/howto-build/shiboken.rst | 54 |
6 files changed, 0 insertions, 329 deletions
diff --git a/doc/howto-build/cmake-primer.rst b/doc/howto-build/cmake-primer.rst deleted file mode 100644 index 6d9224cbd..000000000 --- a/doc/howto-build/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 bindings generator. - -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, and so on. - - -CMake variables ---------------- - -CMake can have its default behavior modified by providing some options in the command line: - -* ``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 `Icecream <http://en.opensuse.org/Icecream>`_ to speed up 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, :program:`make install` will install the files into -the target directory. diff --git a/doc/howto-build/index.rst b/doc/howto-build/index.rst deleted file mode 100644 index e8d1cd100..000000000 --- a/doc/howto-build/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. PySide documentation master file, created by sphinx-quickstart on Fri Mar 6 11:45:08 2009. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Getting started with PySide -=========================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - cmake-primer - setup-apiextractor - setup-generator - shiboken - setup-bindings - - diff --git a/doc/howto-build/setup-apiextractor.rst b/doc/howto-build/setup-apiextractor.rst deleted file mode 100644 index 18f5d4d31..000000000 --- a/doc/howto-build/setup-apiextractor.rst +++ /dev/null @@ -1,52 +0,0 @@ - -.. _api-extractor: - -************** -API Extractor -************** - -Overview -======== - -The **API Extractor** library is used by the bindings generator to -parse the header and typesystem files to create an internal -representation of the API. It is based on the -`QtScriptGenerator <http://labs.trolltech.com/page/Projects/QtScript/Generator>`_ -codebase. - -Getting the sources -=================== - -* Download URL: http://www.pyside.org/downloads/ - -Build requirements -================== - -+ CMake >= 2.6.0 -+ Qt4.5 libraries and development headers >= 4.5 -+ libxml2 libraries and development headers >= 2.6.32 -+ libxslt libraries and development headers >= 1.1.19 - -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 (>= 7) -* cmake (>= 2.6.0) -* libqt4-dev (>= 4.5) -* libxml2-dev -* libxslt1-dev -* pkg-config -* python-sphinx - -And then you can build the package using:: - - $ dpkg-buildpackage -rfakeroot diff --git a/doc/howto-build/setup-bindings.rst b/doc/howto-build/setup-bindings.rst deleted file mode 100644 index 87feec963..000000000 --- a/doc/howto-build/setup-bindings.rst +++ /dev/null @@ -1,82 +0,0 @@ -*************** -Qt 4.6 Bindings -*************** - -Overview -======== - -These bindings allow access of Qt 4.6 libraries as Python modules, -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:`generator-runner` with apropriate parameters; the -generated files are then compiled and linked together to form the -bindings libraries. - -The bindings available at the moment are listed below: - - + QtCore - + QtGui - + QtHelp - + QtMultimedia - + QtNetwork - + QtOpenGL - + QtScript - + QtScriptTools - + QtSql - + QtSvg - + QtUiTools - + QtWebKit - + QtXml - + QtXmlPatterns - + Phonon - -Getting the sources -=================== - -* Download URL: http://www.pyside.org/downloads/ - -Build requirements -================== - - + CMake (>= 2.6.0) - + Qt4.6 libraries and development headers - + Python dev libraries - + Shiboken libraries - + :ref:`generator-runner` - - -Building and installing -======================= - -To build and install just follow the generic cmake instructions in -section :ref:`cmake-primer`. - -Be advised that the build process can be rather lenghty because of the -number of source files that will be compiled. - -Debian packaging -================ - -.. note:: Qt 4.6 is available for Debian in the testing branch (squeeze), Ubuntu 10.04 (Lucid Lynx), and in Maemo 5 (Fremantle) in the upcoming PR 1.2 update. - -In order to compile this package in a Debian environment, make sure the -following packages are installed: - -* debhelper (>= 7) -* cmake (>= 2.6.0) -* python-all-dev -* python-all-dbg -* python-support (>= 0.3.9) -* libqt4-dev -* libphonon-dev -* libqt4-opengl-dev -* shiboken (>= 0.3.0) -* generatorrunner (>= 0.4.1) -* libshiboken-dev (>= 0.3.0) - - -And then you can build the package using:: - - $ dpkg-buildpackage -rfakeroot diff --git a/doc/howto-build/setup-generator.rst b/doc/howto-build/setup-generator.rst deleted file mode 100644 index 6c231ccb5..000000000 --- a/doc/howto-build/setup-generator.rst +++ /dev/null @@ -1,50 +0,0 @@ - -.. _generator-runner: - -**************** -Generator Runner -**************** - -Overview -========================================= - -The **Generator Runner** (A.K.A. :program:`generatorrunner`) is the -program that controls the bindings generation process according to the -rules given by the user through headers, typesystem files and generator -front-ends (such as :ref:`shiboken-generator`). It depends on -: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 (>= 7) -* cmake (>= 2.6.0) -* libqt4-dev (>= 4.5) -* libapiextractor-dev (>= 0.5.0) -* libxlst-dev - -And then you can build the package using:: - - $ dpkg-buildpackage -rfakeroot diff --git a/doc/howto-build/shiboken.rst b/doc/howto-build/shiboken.rst deleted file mode 100644 index d5c19de5b..000000000 --- a/doc/howto-build/shiboken.rst +++ /dev/null @@ -1,54 +0,0 @@ - -.. _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 -+ Python development headers >= 2.5 -+ :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 (>= 7) -* cmake (>= 2.6.0) -* libqt4-dev (>= 4.5) -* libapiextractor-dev (>= 0.5.0) -* libgenrunner-dev (>= 0.4.1) -* generatorrunner (>= 0.4.1) -* python-all-dev -* python-all-dbg - -And then you can build the package using:: - - $ dpkg-buildpackage -rfakeroot |