diff options
| author | Dennis Oberst <dennis.oberst@qt.io> | 2023-10-24 13:46:00 +0200 |
|---|---|---|
| committer | Dennis Oberst <dennis.oberst@qt.io> | 2023-10-26 13:56:42 +0200 |
| commit | 92b9a8807c33120e6347a82a6ab65dc8828dec0e (patch) | |
| tree | 2bfe830727b8e69ea5c7544d44e3a1e9674c93b9 /build_scripts/setup_runner.py | |
| parent | 9205a48848c881c67130e7b96e3ad98aa870052e (diff) | |
docs: deprecate 'build_rst_docs' in favor of 'build_base_docs'
The command for building documentation files has been renamed to
'build_base_docs' and the previous command, 'build_rst_docs', has been
deprecated. All relevant occurrences of the command have been updated
accordingly. In addition, the documentation config and build directory
'build/pyside6/doc/rst' has been renamed to 'build/pyside6/doc/base'.
To ensure a fresh start when generating new documentation, the
auto-generated `examples` and `html` directories are now deleted
before generating new documentation. This change has been made
because these directories are generated anyway, and starting fresh
ensures that there are no conflicts or issues with the new
documentation.
Task-number: PYSIDE-2504
Change-Id: I395ad7e9482b0b68311820d58da362513ebb44b2
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'build_scripts/setup_runner.py')
| -rw-r--r-- | build_scripts/setup_runner.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/build_scripts/setup_runner.py b/build_scripts/setup_runner.py index 6a7de04c9..9bcbb4afe 100644 --- a/build_scripts/setup_runner.py +++ b/build_scripts/setup_runner.py @@ -93,7 +93,7 @@ class SetupRunner(object): setup_cmd.append(self.construct_cmd_line_argument(name, value)) # Add --reuse-build option if requested and not already present. - if (reuse_build and command in ('bdist_wheel', 'build', 'build_rst_docs', 'install') + if (reuse_build and command in ('bdist_wheel', 'build', 'build_base_docs', 'build_rst_docs', 'install') and not self.cmd_line_argument_is_in_args("reuse-build", modified_argv)): setup_cmd.append(self.construct_cmd_line_argument("reuse-build")) return setup_cmd |