diff options
| author | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2025-01-08 11:50:51 +0100 |
|---|---|---|
| committer | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2025-01-20 17:33:28 +0100 |
| commit | c22723e43be912f14c4f4e5d6530d62b4476e957 (patch) | |
| tree | f4d9d1ac4be62b962fe2241f2eb0e11c81233dee | |
| parent | 20d84ed06a2ab988267b35d33cfe6627eb84d80b (diff) | |
Documentation: Fix installation steps in `Building from Source`
- Uses `create_wheels.py` instead of `setup.py install`
- Additionally, fix some spelling mistakes.
Pick-to: 6.8
Change-Id: I79ccdc940295dc48650742af57f3abc1b3e2fd2b
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Ece Cinucen <ece.cinucen@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| -rw-r--r-- | sources/pyside6/doc/building_from_source/linux.rst | 34 | ||||
| -rw-r--r-- | sources/pyside6/doc/building_from_source/macOS.rst | 28 | ||||
| -rw-r--r-- | sources/pyside6/doc/building_from_source/windows.rst | 23 |
3 files changed, 56 insertions, 29 deletions
diff --git a/sources/pyside6/doc/building_from_source/linux.rst b/sources/pyside6/doc/building_from_source/linux.rst index 49d3dc9d8..1e59006e2 100644 --- a/sources/pyside6/doc/building_from_source/linux.rst +++ b/sources/pyside6/doc/building_from_source/linux.rst @@ -33,7 +33,7 @@ project management. The following command creates a virtual environment using `u .. note:: Since the Qt for Python project still uses `setup.py` and not `pyproject.toml`, currently `uv` can only be used as a replacement for `pyenv` for building Qt for Python. If you - have already the `.python_version` file(used by .pyenv) in the project, make sure to + have already the `.python-version` file (used by .pyenv) in the project, make sure to change the version to the `uv`_ Python you want to use. Setting up CLANG @@ -43,7 +43,7 @@ If you don't have libclang already in your system, you can download from the Qt wget https://download.qt.io/development_releases/prebuilt/libclang/libclang-release_18.1.5-based-linux-Rhel8.6-gcc10.3-x86_64.7z -Extract the files, and leave it on any desired path, and set the environment +Extract the files, and leave it in any desired path, and set the environment variable required:: 7z x libclang-release_18.1.5-based-linux-Rhel8.6-gcc10.3-x86_64.7z @@ -77,8 +77,9 @@ For building the documentation:: Building and Installing (setuptools) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The ``setuptools`` approach uses the ``setup.py`` file to execute the build, -install, and packaging steps. +The ``setuptools`` approach uses the ``setup.py`` file to execute the build step and further +uses `create_wheels.py`_ to create the wheels. Once the wheels are created, you can install the +wheels using the `pip` command. Check your Qt installation path, to specifically use that version of qtpaths to build PySide. for example, :command:`/opt/Qt/6.8.0/gcc_64/bin/qtpaths`. @@ -87,13 +88,23 @@ Build can take a few minutes, so it is recommended to use more than one CPU core python setup.py build --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 -To install on the current directory, just run:: +With `uv`_, the build command becomes:: - python setup.py install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + uv run setup.py build --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 -With `uv`_, these commands becomes:: +To create the wheels, just run:: - uv run setup.py build/install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + python create_wheels.py --build-dir=/directory/where/pyside/is/built --no-examples + +On successful completion, the wheels will be created in the `dist` directory. + +.. note:: The `build-dir` typically looks like `build/<your_python_environment_name>`. The + requirement is that this `build-dir` should contain the `packages_for_wheel` directory. + If the `python setup.py` build command was successful, this directory should be present. + +Finally, to install the wheels, use the following command:: + + pip install dist/*.whl Building and Installing (cmake) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -102,7 +113,7 @@ The ``setuptools`` approach includes internal ``CMake`` calls when building and installing the project, but a CMake-only approach is only recommended for packaging the project for distribution builds. -Assumming that Qt is in PATH, for example, the configure step can be done with:: +Assuming that Qt is in PATH, for example, the configure step can be done with:: cmake -B /path/to/the/build/directory \ -S /path/to/the/pyside-setup \ @@ -116,13 +127,13 @@ and then for building:: cmake --build /path/to/the/build/directory --parallel X -where `X` is the amount of processes you want to use. +where `X` is the number of processes you want to use. Finally, the install step can be done with:: cmake --install /path/to/the/build/directory .. note:: You can build only pyside6 or only shiboken6 by using - the diferent source directories with the option `-S`. + the different source directories with the option `-S`. Test installation @@ -135,3 +146,4 @@ Remember to properly set the environment variables for Qt and PySide:: .. _`Qt for Linux/X11`: https://doc.qt.io/qt-6/linux.html .. _`uv`: https://docs.astral.sh/uv/ +.. _`create_wheels.py`: https://code.qt.io/cgit/pyside/pyside-setup.git/tree/create_wheels.py diff --git a/sources/pyside6/doc/building_from_source/macOS.rst b/sources/pyside6/doc/building_from_source/macOS.rst index bb6a0dd2b..dca804cba 100644 --- a/sources/pyside6/doc/building_from_source/macOS.rst +++ b/sources/pyside6/doc/building_from_source/macOS.rst @@ -4,7 +4,7 @@ macOS Requirements ------------ -* `XCode`_ 8.2 (macOS 10.11), 8.3.3 (macOS 10.12), 9 (macOS 10.13), 10.1 (macOS 10.14) +* `Xcode`_ 8.2 (macOS 10.11), 8.3.3 (macOS 10.12), 9 (macOS 10.13), 10.1 (macOS 10.14) * ``sphinx`` package for the documentation (optional). * Depending on your OS, the following dependencies might also be required: @@ -12,7 +12,7 @@ Requirements * Check the platform dependencies of `Qt for macOS`_. -.. _XCode: https://developer.apple.com/xcode/ +.. _Xcode: https://developer.apple.com/xcode/ .. _`Qt for macOS`: https://doc.qt.io/qt-6/macos.html Building from source @@ -37,17 +37,17 @@ project management. The following command creates a virtual environment using `u .. note:: Since the Qt for Python project still uses `setup.py` and not `pyproject.toml`, currently `uv` can only be used as a replacement for `pyenv` for building Qt for Python. If you - have already the `.python_version` file(used by .pyenv) in the project, make sure to + have already the `.python-version` file (used by `pyenv`) in the project, make sure to change the version to the `uv`_ Python you want to use. Setting up CLANG ~~~~~~~~~~~~~~~~ -If you don't have libclang already in your system, you can download from the Qt servers:: +If you don't have `libclang` already in your system, you can download from the Qt servers:: wget https://download.qt.io/development_releases/prebuilt/libclang/libclang-release_18.1.5-based-macos-universal.7z -Extract the files, and leave it on any desired path, and set the environment +Extract the files, and leave it in any desired path, and set the environment variable required:: 7z x libclang-release_18.1.5-based-macos-universal.7z @@ -86,7 +86,7 @@ Build can take a few minutes, so it is recommended to use more than one CPU core python setup.py build --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 -With `uv`_, this commands becomes:: +With `uv`_, this command becomes:: uv run setup.py build --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 @@ -94,13 +94,19 @@ With `uv`_, this commands becomes:: Installing PySide ~~~~~~~~~~~~~~~~~ -To install on the current directory, just run:: +First, create the wheels using the `create_wheels.py`_ script:: - python setup.py install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + python create_wheels.py --build-dir=/directory/where/pyside/is/built --no-examples -With `uv`_, this commands becomes:: +On successful completion, the wheels will be created in the `dist` directory. - uv run setup.py install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 +.. note:: The `build-dir` typically looks like `build/<your_python_environment_name>`. The + requirement is that this `build-dir` should contain the `packages_for_wheel` directory. + If the `python setup.py` build command was successful, this directory should be present. + +Finally, to install the wheels, use the following command:: + + pip install dist/*.whl Test installation ~~~~~~~~~~~~~~~~~ @@ -111,3 +117,5 @@ Remember to properly set the environment variables for Qt and PySide:: python examples/widgets/widgets/tetrix/tetrix.py .. _`uv`: https://docs.astral.sh/uv/ +.. _`create_wheels.py`: https://code.qt.io/cgit/pyside/pyside-setup.git/tree/create_wheels.py + diff --git a/sources/pyside6/doc/building_from_source/windows.rst b/sources/pyside6/doc/building_from_source/windows.rst index 170a8e6a2..d2510a1b6 100644 --- a/sources/pyside6/doc/building_from_source/windows.rst +++ b/sources/pyside6/doc/building_from_source/windows.rst @@ -25,7 +25,7 @@ Building from source on Windows 10 Creating a virtual environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The ``venv`` module allows you to create a local, user-writeable copy of a python environment into +The ``venv`` module allows you to create a local, user-writable copy of a python environment into which arbitrary modules can be installed and which can be removed after use:: python -m venv testenv @@ -41,7 +41,7 @@ project management. The following command creates a virtual environment using `u .. note:: Since the Qt for Python project still uses `setup.py` and not `pyproject.toml`, currently `uv` can only be used as a replacement for `pyenv` for building Qt for Python. If you - have already the `.python_version` file(used by .pyenv) in the project, make sure to + have already the `.python_version` file (used by .pyenv) in the project, make sure to change the version to the `uv`_ Python you want to use. Setting up CLANG @@ -94,7 +94,7 @@ Build can take a few minutes, so it is recommended to use more than one CPU core python setup.py build --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 -With `uv`_, this commands becomes:: +With `uv`_, this command becomes:: uv run setup.py build --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 @@ -119,13 +119,20 @@ Creating Debug Builds Installing PySide ~~~~~~~~~~~~~~~~~ -To install on the current directory, just run:: +First, create the wheels using the `create_wheels.py`_ script:: - python setup.py install --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 + python create_wheels.py --build-dir=C:\directory\where\pyside\is\built --no-examples -With `uv`_, this command becomes:: +On successful completion, the wheels will be created in the `dist` directory. + +.. note:: The `build-dir` typically looks like `build\<your_python_environment_name>`. The + requirement is that this `build-dir` should contain the `packages_for_wheel` directory. + If the `python setup.py` build command was successful, this directory should be present. + +Finally, to install the wheels, use the following command:: + + pip install dist\*.whl - uv run setup.py install --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 Test installation ~~~~~~~~~~~~~~~~~ @@ -133,6 +140,6 @@ Test installation You can execute one of the examples to verify the process is properly working. Remember to properly set the environment variables for Qt and PySide:: - python examples/widgets/widgets/tetrix/tetrix.py + python examples\widgets\widgets\tetrix\tetrix.py .. _`uv`: https://docs.astral.sh/uv/ |