diff options
| author | Thomas P <TPXP@users.noreply.github.com> | 2021-08-08 21:07:54 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-08 15:07:54 -0400 |
| commit | 885a730e4e9e39f6027e377b0f6785b317a1f013 (patch) | |
| tree | e12d5377096b0727520edf9646b2fff3706018bc | |
| parent | 8de44287752f9d2c0112bb3062389462d56ead86 (diff) | |
| download | pyjwt-885a730e4e9e39f6027e377b0f6785b317a1f013.tar.gz | |
DOC: Clarify RSA encoding and decoding depend on the cryptography package (#664)
* DOC: Clarify RSA encoding and decoding depend on the cryptography package
Followup to #208
* DOC: Add a reference to the cryptography section in the installation file
Fixes missing reference in the previously edited file
| -rw-r--r-- | docs/installation.rst | 3 | ||||
| -rw-r--r-- | docs/usage.rst | 2 |
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 6da2ccd..925da97 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -7,6 +7,9 @@ You can install ``PyJWT`` with ``pip``: $ pip install pyjwt + +.. _installation_cryptography + Cryptographic Dependencies (Optional) ------------------------------------- diff --git a/docs/usage.rst b/docs/usage.rst index c5372af..2eacb96 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -17,6 +17,8 @@ Encoding & Decoding Tokens with HS256 Encoding & Decoding Tokens with RS256 (RSA) ------------------------------------------- +RSA encoding and decoding require the ``cryptography`` module. See :ref:`installation_cryptography`. + .. code-block:: pycon >>> import jwt |