diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-11-07 15:04:17 +0100 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-11-08 11:37:10 +0100 |
commit | 274cd626332729ab1beca399572c8d30f9edc7c1 (patch) | |
tree | fe744348e7ee85ef6d8592b028bf6b7f165d9233 /sources/pyside6/doc/gettingstarted | |
parent | a9fc4a26a88165c743a38412f9d48de6c43ab167 (diff) |
Fix up the documentation generation instructions
The manual still mentioned sphinx_tabs, which conflicts with
sphix-panels.
Pick-to: 6.4
Change-Id: I24e6ca11f0d3de4ddc8c69534c1d325fe9f1e523
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/gettingstarted')
-rw-r--r-- | sources/pyside6/doc/gettingstarted/index.rst | 11 |
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 |