Skip to content

chore: Add readthedocs config #348

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
Jun 11, 2021
Merged

Conversation

farleyb-amazon
Copy link
Contributor

Description of changes:
This is primarily to add explicit ignoring of submodules, which have broken our doc builds: https://readthedocs.org/projects/aws-encryption-sdk-python/builds/13981651/

Note that we could also fix the specific error above by moving to the public test vectors module, but more generally this submodule is for testing and doesn't need to be included in documentation.

Testing:
Not really sure how to test this, since it relates to readthedocs integration.

My source material is:
https://sphinx-with-submodules.readthedocs.io/en/latest/ and https://docs.readthedocs.io/en/stable/config-file/v2.html#submodules

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

Check any applicable:

  • Were any files moved? Moving files changes their URL, which breaks all hyperlinks to the files.

This is primarily to add explicit ignoring of submodules.
@farleyb-amazon farleyb-amazon merged commit b5d2678 into aws:master Jun 11, 2021
@farleyb-amazon farleyb-amazon deleted the fix-docs branch June 11, 2021 21:16
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