From 92b9a8807c33120e6347a82a6ab65dc8828dec0e Mon Sep 17 00:00:00 2001 From: Dennis Oberst Date: Tue, 24 Oct 2023 13:46:00 +0200 Subject: 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 --- build_scripts/options.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'build_scripts/options.py') diff --git a/build_scripts/options.py b/build_scripts/options.py index e49dd61cc..59b9a3ffc 100644 --- a/build_scripts/options.py +++ b/build_scripts/options.py @@ -122,7 +122,7 @@ def _jobs_option_value(): def find_qtpaths(): # for these command --qtpaths should not be required - no_qtpaths_commands = ["--help", "--help-commands", "--qt-target-path", "build_rst_docs"] + no_qtpaths_commands = ["--help", "--help-commands", "--qt-target-path", "build_base_docs", "build_rst_docs"] for no_qtpaths_command in no_qtpaths_commands: if any(no_qtpaths_command in argument for argument in sys.argv): @@ -452,7 +452,7 @@ class CommandMixin(object): qt_target_path=qt_target_path, cmake_toolchain_file=cmake_toolchain_file) - if 'build_rst_docs' not in sys.argv: + if 'build_base_docs' not in sys.argv and 'build_rst_docs' not in sys.argv: try: QtInfo().prefix_dir except Exception as e: @@ -540,8 +540,11 @@ class CommandMixin(object): # We also don't do auto-searching if qt-target-path is passed # explicitly. This is to help with the building of host tools # while cross-compiling. - # Skip this process for the 'build_rst_docs' command - if not self.is_cross_compile and not self.qt_target_path and 'build_rst_docs' not in sys.argv: + # Skip this process for the 'build_base_docs' command + if (not self.is_cross_compile + and not self.qt_target_path + and 'build_base_docs' not in sys.argv + and 'build_rst_docs' not in sys.argv): # Enforce usage of qmake in QtInfo if it was given explicitly. if self.qmake: self.has_qmake_option = True -- cgit v1.2.3