Fix Read the Docs builds #1111
Merged
Fix Read the Docs builds #1111
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
This fixes two warnings that were causing Read the Docs builds to fail: ``` WARNING: missing attribute mentioned in :members: option: module jwt.algorithms, attribute AllowedPrivateKeys [autodoc] WARNING: missing attribute mentioned in :members: option: module jwt.algorithms, attribute AllowedPublicKeys [autodoc] ``` The warnings occurred because the `crypto` extra was not configured to be installed in the Read the Docs config file. The problem was overlooked because the tox `docs` environment installed the `crypto` extra.
kurtmckee
force-pushed
the
fix-rtd-builds
branch
from
2d00320 to
57f8254
Compare
kurtmckee
changed the title
Contributor
Author
|
Hello @auvipy! Thank you for continuing to review and merge PRs! When you have an opportunity, would you be willing to review this and other PRs that are open? Each PR targets specific issues in the project infrastructure and codebase. For example, Read the Docs builds have been failing for seven months, and this PR should resolve that infrastructure problem. Thanks again for your work on pyjwt! |
auvipy
approved these changes
Oct 29, 2025
Contributor
Author
|
Thanks @auvipy! Read the Docs builds are now passing. 🥳 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Note
Read the Docs builds have been failing for the last seven months!
This fixes two warnings that were causing Read the Docs builds to fail [recent example]:
The warnings occurred because the
cryptoextra was not configured to be installed in the Read the Docs config file.The problem was overlooked because the tox
docsenvironment installed thecryptoextra, so CI never failed.