Add documentation for jwcrypto.common

Signed-off-by: Simo Sorce <simo@redhat.com>
latchset · May 13, 2022 · 793fb43 · 793fb43
1 parent f294187
commit 793fb43
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/docs/source/common.rst b/docs/source/common.rst
@@ -0,0 +1,38 @@
+Common
+======
+
+Functions
+---------
+.. autofunction:: jwcrypto.common.base64url_encode
+.. autofunction:: jwcrypto.common.base64url_decode
+.. autofunction:: jwcrypto.common.json_encode
+.. autofunction:: jwcrypto.common.json_decode
+
+Classes
+-------
+
+.. autoclass:: jwcrypto.common.JWSEHeaderRegistry
+   :members:
+
+Exceptions
+----------
+
+.. autoclass:: jwcrypto.common.JWException
+
+.. autoclass:: jwcrypto.common.InvalidJWAAlgorithm
+   :show-inheritance:
+
+.. autoclass:: jwcrypto.common.InvalidCEKeyLength
+   :show-inheritance:
+
+.. autoclass:: jwcrypto.common.InvalidJWEOperation
+   :show-inheritance:
+
+.. autoclass:: jwcrypto.common.InvalidJWEKeyType
+   :show-inheritance:
+
+.. autoclass:: jwcrypto.common.InvalidJWEKeyLength
+   :show-inheritance:
+
+.. autoclass:: jwcrypto.common.InvalidJWSERegOperation
+   :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -24,6 +24,7 @@ Contents:
    jws
    jwe
    jwt
+   common
 
 
 Note: In the examples, random or generated output values are replaced