aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/gettingstarted-linux.rst
diff options
context:
space:
mode:
authorCristián Maureira-Fredes <cristian.maureira-fredes@qt.io>2022-10-27 16:20:52 +0200
committerCristián Maureira-Fredes <cristian.maureira-fredes@qt.io>2022-11-03 13:48:46 +0100
commit782acff166d4a2b63846c7ba5493f230cccbd4fc (patch)
treea213ae7028df42b7d5092b922c79f6a29e6fa017 /sources/pyside6/doc/gettingstarted-linux.rst
parent7fde6c515363864f0f16edd0f447a61369d09935 (diff)
doc: order the sidebar content
As a quick-access to all the documentation, the sidebar of the documentation was a mix of topics without any logical order. Creating directories with an index.rst file, and putting the content on the right topic toctree allow us to have a more clear and simple general toc. Change-Id: I43af890ce988946ababcd575d431fc66704c3e85 Pick-to: 6.4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside6/doc/gettingstarted-linux.rst')
-rw-r--r--sources/pyside6/doc/gettingstarted-linux.rst112
1 files changed, 0 insertions, 112 deletions
diff --git a/sources/pyside6/doc/gettingstarted-linux.rst b/sources/pyside6/doc/gettingstarted-linux.rst
deleted file mode 100644
index 7d4000da2..000000000
--- a/sources/pyside6/doc/gettingstarted-linux.rst
+++ /dev/null
@@ -1,112 +0,0 @@
-Getting Started on Linux
-==========================
-
-Requirements
-------------
-
- * GCC
- * ``sphinx`` package for the documentation (optional).
- * Depending on your linux distribution, the following dependencies might also be required:
-
- * ``libgl-dev``, ``python-dev``, ``python-distutils``, and ``python-setuptools``.
-
-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
- 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_100-based-linux-Rhel7.6-gcc5.3-x86_64.7z
-
-Extract the files, and leave it on any desired path, and set the environment
-variable required::
-
- 7z x libclang-release_100-based-linux-Rhel7.6-gcc5.3-x86_64.7z
- export LLVM_INSTALL_DIR=$PWD/libclang
-
-Getting the source
-~~~~~~~~~~~~~~~~~~
-
-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.0::
-
- cd pyside-setup && git checkout 6.2
-
-Install the general dependencies::
-
- pip install -r requirements.txt
-
-.. note:: Keep in mind you need to use the same version as your Qt installation.
- Additionally, :command:`git checkout -b 6.2 --track origin/6.2` could be a better option
- in case you want to work on it.
-
-Building and Installing (setuptools)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The `setuptools` approach uses the `setup.py` file to execute the build,
-install, and packaging steps.
-
-Check your Qt installation path, to specifically use that version of qtpaths to build PySide.
-for example, :command:`/opt/Qt/6.0.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.4.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
-
-To install on the current directory, just run::
-
- python setup.py install --qtpaths=/opt/Qt/6.4.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
-
-Building and Installing (cmake)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-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::
-
- cmake -B /path/to/the/build/directory \
- -S /path/to/the/pyside-setup \
- -DCMAKE_INSTALL_PREFIX=/where/to/install \
- -DPYTHON_EXECUTABLE=/path/to/interpreter
-
-.. note:: You can add `-DFORCE_LIMITED_API=yes` in case you want to have a
- build which will be compatible with Python 3.7+.
-
-and then for building::
-
- cmake --build /path/to/the/build/directory --parallel X
-
-where `X` is the amount 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`.
-
-
-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