Skip to content

Fix docs build errors for Sphinx 5#24870

Merged
potiuk merged 1 commit intoapache:mainfrom
potiuk:fix-doc-errors-failing-in-sphinx-5
Jul 6, 2022
Merged

Fix docs build errors for Sphinx 5#24870
potiuk merged 1 commit intoapache:mainfrom
potiuk:fix-doc-errors-failing-in-sphinx-5

Conversation

@potiuk
Copy link
Member

@potiuk potiuk commented Jul 6, 2022

Sphinx 5 is a little bit more picky about docuementation link
errors that Sphinx 4 had. Due to lack of job dependency (fixed now
via #24866), we accidentally upgraded to Sphinx 5 in constraints
and it started to fail our builds. Fortunately the errors in docs
are very few and we can easily fix it without reverting the
constraint change.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

Sphinx 5 is a little bit more picky about docuementation link
errors that Sphinx 4 had. Due to lack of job dependency (fixed now
via apache#24866), we accidentally upgraded to Sphinx 5 in constraints
and it started to fail our builds. Fortunately the errors in docs
are very few and we can easily fix it without reverting the
constraint change.
@potiuk potiuk requested a review from mik-laj as a code owner July 6, 2022 11:06
@boring-cyborg boring-cyborg bot added area:production-image Production image improvements and fixes area:providers kind:documentation provider:Apache provider:google Google (including GCP) related issues labels Jul 6, 2022
@potiuk potiuk merged commit 6476afd into apache:main Jul 6, 2022
@potiuk potiuk deleted the fix-doc-errors-failing-in-sphinx-5 branch July 6, 2022 11:29
@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label Aug 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:production-image Production image improvements and fixes area:providers kind:documentation provider:google Google (including GCP) related issues type:doc-only Changelog: Doc Only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments