Fix ReadTheDocs Builds #271
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@ ## main #271 +/- ## ======================================= Coverage 99.01% 99.01% ======================================= Files 26 26 Lines 3958 3958 ======================================= Hits 3919 3919 Misses 39 39
|
addressing https://stackoverflow.com/a/56469300 (sphinx >=1.3)
this should fail the readthedocs build: https://readthedocs.org/projects/python-driver-for-arangodb/builds/
(the less changes the better)
aMahanna commented Aug 15, 2023
| @@ -0,0 +1,3 @@ | |||
| requests_toolbelt | |||
| importlib_metadata | |||
| jwt | |||
There was a problem hiding this comment.
This is required to support the sphinx autodoc functionality (for example, see the following no module named 'jwt' error: https://readthedocs.org/projects/python-driver-for-arangodb/builds/21620433/)
apetenchea approved these changes Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
fixes #272
Address the ReadTheDocs migration required as indicated by recent builds (which have also been silently failing):
Image
This is done by introducing a
.readthedocs.yamlfileSee https://blog.readthedocs.com/migrate-configuration-v2/
Preview the fixed API Spec page: https://docs.python-arango.com/en/fix-readthedocs/specs.html