Skip to content

Commit 885a730

Browse files
authored
DOC: Clarify RSA encoding and decoding depend on the cryptography package (jpadilla#664)
* DOC: Clarify RSA encoding and decoding depend on the cryptography package Followup to jpadilla#208 * DOC: Add a reference to the cryptography section in the installation file Fixes missing reference in the previously edited file
1 parent 8de4428 commit 885a730

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/installation.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ You can install ``PyJWT`` with ``pip``:
77
88
$ pip install pyjwt
99
10+
11+
.. _installation_cryptography
12+
1013
Cryptographic Dependencies (Optional)
1114
-------------------------------------
1215

docs/usage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Encoding & Decoding Tokens with HS256
1717
Encoding & Decoding Tokens with RS256 (RSA)
1818
-------------------------------------------
1919

20+
RSA encoding and decoding require the ``cryptography`` module. See :ref:`installation_cryptography`.
21+
2022
.. code-block:: pycon
2123
2224
>>> import jwt

0 commit comments

Comments
 (0)