Skip to content

Commit

Permalink
DOC: Clarify RSA encoding and decoding depend on the cryptography pac…
Browse files Browse the repository at this point in the history
…kage (#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
  • Loading branch information
TPXP committed Aug 8, 2021
1 parent 8de4428 commit 885a730
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/installation.rst
Expand Up @@ -7,6 +7,9 @@ You can install ``PyJWT`` with ``pip``:
$ pip install pyjwt
.. _installation_cryptography
Cryptographic Dependencies (Optional)
-------------------------------------

Expand Down
2 changes: 2 additions & 0 deletions docs/usage.rst
Expand Up @@ -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
Expand Down

0 comments on commit 885a730

Please sign in to comment.