diff options
| author | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-05 17:02:16 +0200 |
|---|---|---|
| committer | Shyamnath Premnadh <Shyamnath.Premnadh@qt.io> | 2024-08-12 10:21:38 +0200 |
| commit | 44385439c3b9879dfa35a3c5635493beec77cb92 (patch) | |
| tree | b4b55a64c6eb0e972c4075caf7da1680ad2725c7 /sources/pyside6/doc/building_from_source/macOS.rst | |
| parent | 19050e72d1b2be21d95e8d128574a49043a48bd6 (diff) | |
Documentation: Rearrange sections
- Rename 'Quick Start' to 'Getting Started'. Also, update the links
accordingly.
- The page 'Getting Started' is a building from source page. Hence
renamed it accordingly with 3 sections - Linux, macOS and Windows.
Each sections contains the steps to build from source for the specific
platform.
- Move 'Package Details' into the main table of contents
- Move 'Porting from PySide2 to PySide6' into the 'Getting Started'
section.
- Additionally, fix the links accordingly and also fix some broken links
- Additionally, increase the minumum Python version from 3.7 to 3.8
in the Getting Started section.
Task-number: PYSIDE-2833
Task-number: PYSIDE-2837
Change-Id: I07f35dbe583533ff122f6ecb4deeb9c95389b3d1
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/building_from_source/macOS.rst')
| -rw-r--r-- | sources/pyside6/doc/building_from_source/macOS.rst | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/sources/pyside6/doc/building_from_source/macOS.rst b/sources/pyside6/doc/building_from_source/macOS.rst new file mode 100644 index 000000000..7afbdf4c7 --- /dev/null +++ b/sources/pyside6/doc/building_from_source/macOS.rst @@ -0,0 +1,89 @@ +macOS +===== + +Requirements +------------ + +* `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: + + * ``libgl-dev``, ``python-dev``, and ``python-setuptools``. + +* Check the platform dependencies of `Qt for macOS`_. + +.. _XCode: https://developer.apple.com/xcode/ +.. _`Qt for macOS`: https://doc.qt.io/qt-6/macos.html + +Building from source +-------------------- + +Creating a virtual environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``venv`` module allows you to create a local, user-writeable copy of a python environment into +which arbitrary modules can be installed and which can be removed after use:: + + python -m venv testenv # your interpreter could be called 'python3' + source testenv/bin/activate + +will create and use a new virtual environment, which is indicated by the command prompt changing. + +Setting up CLANG +~~~~~~~~~~~~~~~~ + +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 +variable required:: + + 7z x libclang-release_18.1.5-based-macos-universal.7z + export LLVM_INSTALL_DIR=$PWD/libclang + +Getting PySide +~~~~~~~~~~~~~~ + +Cloning the official repository can be done by:: + + git clone https://code.qt.io/pyside/pyside-setup + +Checking out the version that we want to build, for example, 6.8:: + + cd pyside-setup && git checkout 6.8 + +Install the general dependencies:: + + pip install -r requirements.txt + +For building the documentation:: + + pip install -r requirements-doc.txt + +.. note:: Keep in mind you need to use the same version as your Qt installation + +Building PySide +~~~~~~~~~~~~~~~ + +Check your Qt installation path, to specifically use that version of qtpaths to build PySide. +for example, ``/opt/Qt/6.8.0/gcc_64/bin/qtpaths``. + +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 + +Installing PySide +~~~~~~~~~~~~~~~~~ + +To install on the current directory, just run:: + + python setup.py install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + +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.py |