chore: Add readthedocs config #348
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: