diff options
Diffstat (limited to 'sources/shiboken6/doc/gettingstarted.rst')
| -rw-r--r-- | sources/shiboken6/doc/gettingstarted.rst | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/sources/shiboken6/doc/gettingstarted.rst b/sources/shiboken6/doc/gettingstarted.rst index 6ab337680..cad49086d 100644 --- a/sources/shiboken6/doc/gettingstarted.rst +++ b/sources/shiboken6/doc/gettingstarted.rst @@ -11,13 +11,13 @@ need to continue if you already have a built PySide. General Requirements ^^^^^^^^^^^^^^^^^^^^ - * **Python**: 3.6+ - * **Qt:** 6.0+ - * **libclang:** The libclang library, recommended: version 10 for 6.0+. - Prebuilt versions of it can be `downloaded here`_. - * **CMake:** 3.1+ is needed. +* **Python**: 3.7+ +* **Qt:** 6.0+ +* **libclang:** The libclang library, recommended: version 10 for 6.0+. + Prebuilt versions of it can be `downloaded here`_. +* **CMake:** 3.1+ is needed. -.. _downloaded here: http://download.qt.io/development_releases/prebuilt/libclang/ +.. _downloaded here: https://download.qt.io/development_releases/prebuilt/libclang/ Simple build ^^^^^^^^^^^^ @@ -25,13 +25,13 @@ Simple build If you need only Shiboken Generator, a simple build run would look like this:: # For the required libraries (this will also build the shiboken6 python module) - python setup.py install --qmake=/path/to/qmake \ + python setup.py install --qtpaths=/path/to/qtpaths \ --build-tests \ --verbose-build \ --internal-build-type=shiboken6 # For the executable - python setup.py install --qmake=/path/to/qmake \ + python setup.py install --qtpaths=/path/to/qtpaths \ --build-tests \ --verbose-build \ --internal-build-type=shiboken6-generator @@ -40,7 +40,7 @@ The same can be used for the module, changing the value of ``internal-build-type ``shiboken6-module``. .. warning:: If you are planning to use PySide too, for examples like - 'scriptableapplication' you need to have build it as well. The main issue is + 'scriptableapplication' you need to have build it as well. The main issue is that your PySide and Shiboken needs to be build using the same dependencies from Qt and libclang. @@ -54,7 +54,7 @@ You can get the ``shiboken6_generator`` wheels from Qt servers, and you can stil via ``pip``:: pip install \ - --index-url=http://download.qt.io/official_releases/QtForPython/ \ + --index-url=https://download.qt.io/official_releases/QtForPython/ \ --trusted-host download.qt.io \ shiboken6 pyside6 shiboken6_generator @@ -62,11 +62,13 @@ via ``pip``:: The ``whl`` package cannot automatically discover in your system the location for: * Clang installation, -* ``qmake`` location with the same version as the one described in the wheel, +* Qt location (indicated by the path of the ``qtpaths`` tool) with the same + version/build as the one described in the wheel, * Qt libraries with the same package version. So using this process requires you to manually modify the variables: * ``CLANG_INSTALL_DIR`` must be set to where the libraries are, -* ``PATH`` must include the location for a ``qmake`` with the same Qt version as the package, +* ``PATH`` must include the location for the ``qtpaths`` tool with the same Qt + version as the package, * ``LD_LIBRARY_PATH`` including the Qt libraries and Clang libraries paths. |