Skip to content

chore: update readthedocs config #374

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

Merged
merged 1 commit into from
Nov 9, 2021

Conversation

farleyb-amazon
Copy link
Contributor

@farleyb-amazon farleyb-amazon commented Nov 9, 2021

Description of changes:
Fix RTD config to point to correct requirements. Also pin dependencies so we have reproducible builds.

See failing builds here: https://readthedocs.org/projects/aws-encryption-sdk-python/builds/15218410/

And known issue here: https://github.yuuza.net/sphinx-doc/sphinx/issues/9727

Testing:
I couldn't precisely reproduce this issue because it seems to be specific to how RTD configures its environment (in our case, pulling in a sphinx dependency < 2). That said, when I locally run the sphinx build to create docs (which specifies sphinx>1.3.0) it succeeds.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link
Contributor

@josecorella josecorella left a comment

Choose a reason for hiding this comment

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

:ship-it-parrot:

@farleyb-amazon farleyb-amazon merged commit 193dfc7 into aws:master Nov 9, 2021
@farleyb-amazon farleyb-amazon deleted the docs-fix branch November 9, 2021 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants