Skip to content

Add --one-pass-only parameter to breeze docs build command #30555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2023
Merged

Add --one-pass-only parameter to breeze docs build command #30555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions dev/breeze/src/airflow_breeze/commands/developer_commands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,11 @@ def start_airflow(
"Implies --clean-build",
is_flag=True,
)
@click.option(
"--one-pass-only",
help="Builds documentation in one pass only. This is useful for debugging sphinx errors.",
is_flag=True,
)
@option_github_repository
@option_verbose
@option_dry_run
Expand All @@ -320,6 +325,7 @@ def build_docs(
spellcheck_only: bool,
for_production: bool,
clean_build: bool,
one_pass_only: bool,
package_filter: tuple[str],
github_repository: str,
):
Expand Down
1 change: 1 addition & 0 deletions dev/breeze/src/airflow_breeze/commands/developer_commands_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@
"--spellcheck-only",
"--clean-build",
"--for-production",
"--one-pass-only",
"--package-filter",
"--github-repository",
],
Expand Down
3 changes: 3 additions & 0 deletions dev/breeze/src/airflow_breeze/params/doc_build_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class DocBuildParams:
spellcheck_only: bool
for_production: bool
skip_environment_initialization: bool = False
one_pass_only: bool = False
github_actions = os.environ.get("GITHUB_ACTIONS", "false")

@property
Expand All @@ -40,6 +41,8 @@ def args_doc_builder(self) -> list[str]:
doc_args.append("--spellcheck-only")
if self.for_production:
doc_args.append("--for-production")
if self.one_pass_only:
doc_args.append("--one-pass-only")
if AIRFLOW_BRANCH != "main":
doc_args.append("--disable-provider-checks")
if self.package_filter and len(self.package_filter) > 0:
Expand Down
2 changes: 1 addition & 1 deletion images/breeze/output-commands-hash.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Please do not solve it but run `breeze setup regenerate-command-images`.
# This command should fix the conflict and regenerate help images that you have conflict with.
main:83de6a9bf2b1afecd1f9ce4cd0493733
build-docs:61ddf42565c6e39b2a1b228b2a0e89de
build-docs:093cf82ab80aee65c6ada9b16ac60612
ci:find-newer-dependencies:8fa2b57f5f0523c928743b235ee3ab5a
ci:fix-ownership:fee2c9ec9ef19686792002ae054fecdd
ci:free-space:47234aa0a60b0efd84972e6e797379f8
Expand Down
Loading