Skip to content

Fix building documentation for PSRP#21260

Merged
potiuk merged 1 commit intoapache:mainfrom
potiuk:fix-doc-building-failing-on-psrp
Feb 1, 2022
Merged

Fix building documentation for PSRP#21260
potiuk merged 1 commit intoapache:mainfrom
potiuk:fix-doc-building-failing-on-psrp

Conversation

@potiuk
Copy link
Copy Markdown
Member

@potiuk potiuk commented Feb 1, 2022

The PSRP docs building fails in main/PR after merging #19806
because the docusmentation needs to be rebuilt one more time
because of sequence of building the documentation. In main and
new PRs the "apache-airflow" documentation is not build
before misrosoft psrp is built, and the psrp docs uses
reference to the airlfow "concept" documentation and the
link is not existing yet in the inventory for apache-airflow.
This results in a race condition where PSRP documentation fails
with toctree contains reference to nonexisting document

The error has not been included in the list of errors that
are "eligible for rebuild" and the race condition was triggered.

This change adds the error to errors "eligible for rebuild" and
makes PSRP documentation build succeed on retry.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, 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 UPDATING.md.

The PSRP docs building failes in main/PR after merging apache#19806
because the docusmentation needs to be rebuilt one more time
because of sequence of building the documentation. In main and
new PRs the "apache-airflow" documentation is not build
before misrosoft psrp is built, and the psrp docs uses
reference to the airlfow "concept" documentation and the
link is not existing yet in the inventory for apache-airflow.
This results in a race condition where PSRP documentation fails
with `toctree contains reference to nonexisting document`

The error has not been included in the list of errors that
are "eligible for rebuild" and the race condition was triggered.

This change adds the error to errors "eligible for rebuild" and
makes PSRP documentation build succeed on retry.
@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Feb 1, 2022
@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 1, 2022

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@potiuk
Copy link
Copy Markdown
Member Author

potiuk commented Feb 1, 2022

Build docs is green. Merging.

@potiuk potiuk merged commit 9a20788 into apache:main Feb 1, 2022
@potiuk potiuk deleted the fix-doc-building-failing-on-psrp branch February 1, 2022 22:56
@potiuk potiuk restored the fix-doc-building-failing-on-psrp branch April 26, 2022 20:48
@potiuk potiuk deleted the fix-doc-building-failing-on-psrp branch July 29, 2022 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:documentation okay to merge It's ok to merge this PR as it does not require more tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants