Skip to content
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.

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

Fix docs build on v2-10-test branch #47820

Open
wants to merge 3 commits into
base: v2-10-test
Choose a base branch
from

Conversation

jscheffl
Copy link
Contributor

Docs build fails on v2.10-test branch, see https://github.com/apache/airflow/actions/runs/13875806106/job/38828565732

This bug fix is rather a bit of workaround - as a couple of doc references in providers have moved with in-compatibility to v2-10-test the cached object inventories which are used normally are in-compatible. As providers are not maintained on the maintenance branch... the workaround is to build just all docs (with the trade-off of a bit longer build time... but we do not build too often on maintenance branch...) and "tweak" the outdated provider docs to have no errors.

Other ideas welcome as well. But with this the core docs are now building again.

@jscheffl
Copy link
Contributor Author

This PR is "pretty RED" but at least it fixes the docs buils and spell check in v2-10-test branch.

I'd split the fixing of other stuff in another PR.

@amoghrajesh
Copy link
Contributor

Yea i think a split that fixes your issue vs everything else would be good

1 similar comment
@amoghrajesh
Copy link
Contributor

Yea i think a split that fixes your issue vs everything else would be good

@@ -973,7 +973,7 @@ def test_expected_output_pull_request_v2_7(
"run-tests": "true",
"docs-build": "true",
"skip-pre-commits": "check-airflow-provider-compatibility,check-extra-packages-references,check-provider-yaml-valid,identity,lint-helm-chart,mypy-airflow,mypy-dev,mypy-docs,mypy-providers,validate-operators-init",
"docs-list-as-string": "apache-airflow docker-stack",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. Are you sure this is right ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not happy about this but if the build is running with "apache-airflow docker-stack" then it seems the docsbuild catches Sphinx inventories from "current" providers and then some link breaking changes generate fails. See for example here: https://github.com/apache/airflow/actions/runs/13887634551/job/38854668394?pr=47755

Therefore to fix docs build my proposal in this PR is to build all documentation even though only core is published/needed.

But maybe I am not creative/experienced enough to understand what is broken in the docsbuild.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants