From 57f825407ed31db917c5a8ea0e255babab65f591 Mon Sep 17 00:00:00 2001 From: Kurt McKee Date: Thu, 23 Oct 2025 15:01:27 -0500 Subject: [PATCH] Fix Read the Docs builds 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. --- .readthedocs.yaml | 1 + CHANGELOG.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 77a05b303..20790a0a2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,6 +13,7 @@ python: path: "." extra_requirements: - "docs" + - "crypto" sphinx: configuration: "docs/conf.py" diff --git a/CHANGELOG.rst b/CHANGELOG.rst index d35ee036a..864250474 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -23,6 +23,7 @@ Added - Support Python 3.14, and test against PyPy 3.10 and 3.11 by @kurtmckee in `#1104 `__ - Docs: Standardize CHANGELOG links to PRs by @kurtmckee in `#1110 `__ +- Docs: Fix Read the Docs builds by @kurtmckee in `#1111 `__ - Docs: Add example of using leeway with nbf by @djw8605 in `#1034 `__ - Docs: Refactored docs with ``autodoc``; added ``PyJWS`` and ``jwt.algorithms`` docs by @pachewise in `#1045 `__ - Docs: Documentation improvements for "sub" and "jti" claims by @cleder in `#1088 `__