diff options
| author | Keith Kyzivat <keith.kyzivat@qt.io> | 2023-03-07 14:24:27 -0500 |
|---|---|---|
| committer | Keith Kyzivat <keith.kyzivat@qt.io> | 2023-03-10 08:35:44 -0500 |
| commit | 2160cefd634dbbe1b551f1bb3a3d163ef5440841 (patch) | |
| tree | 2fa7883c36147fc038c31071e567356bcc6baae7 /sources/pyside6/doc/gettingstarted | |
| parent | 97fd93f3660a8b2361691c7dbea9fa82e933194b (diff) | |
build_rst_docs: Inform of requirements-doc.txt requirement
Inform user that `pip install -r requirements-doc.txt` should be
performed prior to invocation of build_rst_docs target.
Task-number: PYSIDE-1106
Change-Id: Icb435fcd592dcd147cd3fb1867349530fae536fc
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@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 | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/sources/pyside6/doc/gettingstarted/index.rst b/sources/pyside6/doc/gettingstarted/index.rst index 379db6294..8b4c56da0 100644 --- a/sources/pyside6/doc/gettingstarted/index.rst +++ b/sources/pyside6/doc/gettingstarted/index.rst @@ -413,13 +413,13 @@ Starting from 5.15, there are two options to build the documentation: The process of parsing Qt headers to generate the PySide API documentation can take several minutes, this means that modifying a specific section of the rst files we currently have, might -become a hard task. +become a hard task. You may only care about the ReStructuredText only documentation. -For this, you can install :command:`sphinx` on a virtual environment, and execute the following command:: +To generate this, execute the following command:: python setup.py build_rst_docs -which will generate a ``html/`` directory with the following structure:: +This will generate an ``html/`` directory with the following structure:: html └── pyside6 |