diff options
| author | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2022-04-07 16:09:33 +0200 |
|---|---|---|
| committer | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2022-04-09 11:45:58 +0200 |
| commit | e4c51dac4ec2b3d6c6c14ca63d62c11bade62909 (patch) | |
| tree | 08ae82c02c3827ea05394ba60ad64ca89a65a139 /sources/pyside6 | |
| parent | fca1416b4f4aedc640f05a8183e04b67ea117495 (diff) | |
doc: skip the documentation build by default
This reverse the current approach of building the documentation
by default, and replace the skip-docs parameter by a build-docs one.
A warning is printed when the --skip-docs is used,
and another warning is displayed when using --doc-build-online
without the --build-docs option.
Change-Id: I2bf8302881b51e9831795a7e881b106022cdffa8
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside6')
| -rw-r--r-- | sources/pyside6/doc/CMakeLists.txt | 6 | ||||
| -rw-r--r-- | sources/pyside6/doc/gettingstarted.rst | 11 |
2 files changed, 12 insertions, 5 deletions
diff --git a/sources/pyside6/doc/CMakeLists.txt b/sources/pyside6/doc/CMakeLists.txt index 7bc1424bf..9d4fcf144 100644 --- a/sources/pyside6/doc/CMakeLists.txt +++ b/sources/pyside6/doc/CMakeLists.txt @@ -8,7 +8,7 @@ include(FindDocTools) # When the doc project is built as part of the pyside project, we show informational message # and return early if requirements are not met. if(NOT CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) - if(QT_SRC_DIR AND SPHINX_BUILD AND DOT_EXEC AND NOT SKIP_DOCS) + if(QT_SRC_DIR AND SPHINX_BUILD AND DOT_EXEC AND BUILD_DOCS) # All requirements met, proceed. else() set(reasons "") @@ -21,8 +21,8 @@ if(NOT CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) if(NOT DOT_EXEC) list(APPEND reasons " graphviz not found\n") endif() - if(SKIP_DOCS) - list(APPEND reasons " SKIP_DOCS was set to TRUE\n") + if(NOT BUILD_DOCS) + list(APPEND reasons " BUILD_DOCS was set to FALSE (default)\n") endif() message(STATUS "apidoc generation targets disabled due to the following reasons:\n" ${reasons}) diff --git a/sources/pyside6/doc/gettingstarted.rst b/sources/pyside6/doc/gettingstarted.rst index 497b9afa8..1a465b79c 100644 --- a/sources/pyside6/doc/gettingstarted.rst +++ b/sources/pyside6/doc/gettingstarted.rst @@ -75,7 +75,9 @@ Other important options to consider are: * ``--openssl=/path/to/openssl/bin``, to use a different path for OpenSSL, * ``--standalone``, to copy over the Qt libraries into the final package to make it work on other machines, - * ``--doc-build-online``, to build documentation using the online template. + * ``--build-docs``, to enable the documentation build. + * ``--doc-build-online``, to build documentation using the online template (by + default it uses the offline) Testing the installation ------------------------ @@ -355,6 +357,10 @@ Troubleshooting Building the documentation -------------------------- +Starting from 6.3, the documentation is not being built by default. +When using the second option described in this section, make sure to use the +``--build-docs`` option. + Starting from 5.15, there are two options to build the documentation: 1. Building rst-only documentation (no API) @@ -403,7 +409,8 @@ Since the process relies on a Qt installation, you need to specify where the export QT_SRC_DIR=/path/to/qtbase -Once the build process finishes, you can go to the generated ``*_build/*_release/pyside6`` +Once the common ``setup.py`` build process finishes (remember to use ``--build-docs`` to enable +the documentation build), you can go to the generated ``*_build/*_release/pyside6`` directory, and run:: ninja apidoc |