Skip to content

Fix docs build on RTD - #12161

Merged
mik-laj merged 4 commits into
apache:masterfrom
PolideaInternal:fix-docs-build
Nov 7, 2020
Merged

Fix docs build on RTD#12161
mik-laj merged 4 commits into
apache:masterfrom
PolideaInternal:fix-docs-build

Conversation

@mik-laj

@mik-laj mik-laj commented Nov 7, 2020

Copy link
Copy Markdown
Member

The docs/build_docs.py file is not used by RTD, so we need to use sphinx extensions. I tested this change locally, but didn't test it on RTD.


^ 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.

@mik-laj
mik-laj requested review from ashb and potiuk November 7, 2020 15:01

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice! Much better than in our scripts!

Just one problem copied from the original code.

Comment thread docs/exts/provider_init_hack.py Outdated
Comment thread docs/conf.py
@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 Nov 7, 2020
@github-actions

github-actions Bot commented Nov 7, 2020

Copy link
Copy Markdown
Contributor

The PR is ready to be merged. No tests are needed!

@github-actions

github-actions Bot commented Nov 7, 2020

Copy link
Copy Markdown
Contributor

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.

Comment thread docs/build_docs.py
:return:
"""
extensions_to_use = [
'provider_init_hack',

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

For spell checking, we should also load this plugin.

@mik-laj
mik-laj merged commit bc2ee5e into apache:master Nov 7, 2020
@mik-laj
mik-laj deleted the fix-docs-build branch November 7, 2020 17:10
@mik-laj

mik-laj commented Nov 7, 2020

Copy link
Copy Markdown
Member Author

All works: https://airflow.readthedocs.io/en/latest/_api/index.html

@potiuk

potiuk commented Nov 7, 2020

Copy link
Copy Markdown
Member

cool!

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

Labels

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.

2 participants