diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2021-02-09 08:50:59 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2021-02-09 09:09:53 +0100 |
| commit | 13e63be261a89ed9c051028225d63a30b1f005af (patch) | |
| tree | def7a56ccc6b4f2ff66297de2f8ba2656e16f464 /sources/pyside6/doc/gettingstarted.rst | |
| parent | da15fc958dafc51901431cf5d9b98b082c8c2690 (diff) | |
PySide6/Documentation: Update the getting started page on doc build
Mention ninja and how to re-run sphinx.
Pick-to: 6.0
Task-number: PYSIDE-841
Change-Id: Id169da66dcfd09640800da52661dbd842b74f15b
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/gettingstarted.rst')
| -rw-r--r-- | sources/pyside6/doc/gettingstarted.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/sources/pyside6/doc/gettingstarted.rst b/sources/pyside6/doc/gettingstarted.rst index 1baac0c37..18c5dba21 100644 --- a/sources/pyside6/doc/gettingstarted.rst +++ b/sources/pyside6/doc/gettingstarted.rst @@ -153,7 +153,7 @@ you will use with your ``qmake`` is located:: Once the build process finishes, you can go to the generated ``*_build/*_release/pyside6`` directory, and run:: - make apidoc + ninja apidoc .. note:: The :command:`apidoc` make target builds offline documenation in QCH (Qt Creator Help) format by default. You can switch to building for the online use with the ``--doc-build-online`` @@ -163,6 +163,11 @@ Finally, you will get a ``html`` directory containing all the generated document help files, ``PySide.qch`` and ``Shiboken.qch``, can be moved to any directory of your choice. You can find ``Shiboken.qch`` in the build directory, ``*_build\*_release\shiboken6\doc\html``. +If you want to temporarily change a ``.rst`` file to examine the impact on +formatting, you can re-run ``sphinx`` in the ``doc`` directory:: + + sphinx-build rst html + Viewing offline documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |