Add --local-theme flag to breeze build-docs for local theme development - #70139
Open
srchilukoori wants to merge 1 commit into
Open
Add --local-theme flag to breeze build-docs for local theme development#70139srchilukoori wants to merge 1 commit into
srchilukoori wants to merge 1 commit into
Conversation
srchilukoori
requested review from
amoghrajesh,
ashb,
bugraoz93,
choo121600,
ephraimbuddy,
gopidesupavan,
jason810496,
jedcunningham,
jscheffl,
potiuk and
vatsrahul1001
as code owners
July 20, 2026 16:44
Member
|
I think we also need a doc describing the process. It also should run doc build to automatically rebuild changes (The docs build already has this option) and we should make sure that the mounted sphinx_theme files are automatically rebuilt when they are changed in the mounted directory - this should be locally tested if ti works as expected |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a
--local-themeflag tobreeze build-docsthat bind-mounts a localsphinx-airflow-theme directory into the container. This lets developers
iterate on theme changes without publishing a wheel or bumping versions.
Usage:
breeze build-docs --local-theme ~/airflow-site/sphinx_airflow_themeFollows the existing
--mount-ui-distcompose overlay pattern: one newcompose file, one ShellParams field, one click option. Default behavior
(no flag) is unchanged; CI never passes
--local-theme.This replaces the approach in #65840 (adding sphinx-airflow-theme as a uv
workspace member), which was closed after the reviewer pivoted to a
bind-mount approach.
closes: #45576
related: #65840
Files changed
scripts/ci/docker-compose/mount-local-theme.yml$LOCAL_THEME_PATHover/opt/airflow/docs-theme/sphinx_airflow_theme/dev/breeze/src/airflow_breeze/utils/path_utils.pydev/breeze/src/airflow_breeze/commands/common_options.py--local-themeclick option (Path, dir-only, resolve)dev/breeze/src/airflow_breeze/params/shell_params.pydev/breeze/src/airflow_breeze/commands/developer_commands.pybuild_docsand_build_python_docsdev/breeze/src/airflow_breeze/commands/developer_commands_config.pydev/breeze/tests/test_shell_params.pydev/breeze/doc/images/output_build-docs.*Test plan
pytest dev/breeze/tests/test_shell_params.py(20 passed)pytest dev/breeze/tests/test_docker_command_utils.py dev/breeze/tests/test_run_test_args.py(86 passed)prek run --from-ref upstream/main --stage pre-commit(all passed)breeze build-docs --local-theme <path>with a local airflow-site checkoutWas generative AI tooling used to co-author this PR?