aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2022-11-07 15:04:17 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2022-11-08 16:13:19 +0100
commit02dcca87c205eab0fd4ac8080b509e5905ab4cb4 (patch)
tree95f40500f2e60c9895328baf4005e30c9c97e1d9
parent8d305aa53c4b00ae51bb000512d3524eb213568f (diff)
Fix up the documentation generation instructions
The manual still mentioned sphinx_tabs, which conflicts with sphix-panels. Change-Id: I24e6ca11f0d3de4ddc8c69534c1d325fe9f1e523 Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 274cd626332729ab1beca399572c8d30f9edc7c1)
-rw-r--r--sources/pyside6/doc/gettingstarted/index.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/sources/pyside6/doc/gettingstarted/index.rst b/sources/pyside6/doc/gettingstarted/index.rst
index 814a9c48e..36da0bea9 100644
--- a/sources/pyside6/doc/gettingstarted/index.rst
+++ b/sources/pyside6/doc/gettingstarted/index.rst
@@ -419,16 +419,19 @@ modifying the build instructions, and more.
The documentation is being generated using **qdoc** to get the API information, and also **sphinx**
for the local Python related notes.
-The system required ``libxml2`` and ``libxslt``, also on the Python environment, ``sphinx`` and
-``graphviz`` need to be installed before running the installation process::
+The system requires the ``libxml2`` and ``libxslt`` libraries.
+In the Python environment, ``graphviz`` needs to be installed on top
+of the modules listed in ``requirements.txt`` before running the
+installation process::
- pip install graphviz sphinx sphinx_tabs
+ pip install graphviz
After installing ``graphviz``, the ``dot`` command needs to be in PATH, otherwise,
the process will fail. Installing ``graphviz`` system-wide is also an option.
Since the process relies on a Qt installation, you need to specify where the
-``qtbase`` directory is located::
+``qtbase`` directory of a Qt source tree is located, either by using
+the command line option ``--qt-src-dir`` or setting the environment variable::
export QT_SRC_DIR=/path/to/qtbase