diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 6caa39ae42926..e91629744463f 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -176,9 +176,8 @@ fi ### SINGLE-PAGE DOCS ### if [[ -z "$CHECK" || "$CHECK" == "single-docs" ]]; then - python doc/make.py --warnings-are-errors --single pandas.Series.value_counts - python doc/make.py --warnings-are-errors --single pandas.Series.str.split - python doc/make.py clean + python doc/make.py --warnings-are-errors --no-browser --single pandas.Series.value_counts + python doc/make.py --warnings-are-errors --no-browser --single pandas.Series.str.split fi exit $RET diff --git a/doc/make.py b/doc/make.py index 23b18d69acc04..dfa8ae6c1e34c 100755 --- a/doc/make.py +++ b/doc/make.py @@ -45,12 +45,14 @@ def __init__( single_doc=None, verbosity=0, warnings_are_errors=False, + no_browser=False, ) -> None: self.num_jobs = num_jobs self.include_api = include_api self.whatsnew = whatsnew self.verbosity = verbosity self.warnings_are_errors = warnings_are_errors + self.no_browser = no_browser if single_doc: single_doc = self._process_single_doc(single_doc) @@ -234,11 +236,11 @@ def html(self): os.remove(zip_fname) if ret_code == 0: - if self.single_doc_html is not None: + if self.single_doc_html is not None and not self.no_browser: self._open_browser(self.single_doc_html) else: self._add_redirects() - if self.whatsnew: + if self.whatsnew and not self.no_browser: self._open_browser(os.path.join("whatsnew", "index.html")) return ret_code @@ -349,6 +351,12 @@ def main(): action="store_true", help="fail if warnings are raised", ) + argparser.add_argument( + "--no-browser", + help="Don't open browser", + default=False, + action="store_true", + ) args = argparser.parse_args() if args.command not in cmds: @@ -374,6 +382,7 @@ def main(): args.single, args.verbosity, args.warnings_are_errors, + args.no_browser, ) return getattr(builder, args.command)()