Split JOSE API docs

2026-07-26 07:39:52 +02:00 · 2015-10-21 17:06:36 -07:00
parent 5b757bdff2
commit ca464c25fb
10 changed files with 46 additions and 63 deletions
@@ -5,4 +5,4 @@ API Documentation
 .. toctree::
   :glob:

-   api/**
+   api/*
@@ -1,67 +1,10 @@
-:mod:`acme.jose`
-================
-
-.. contents::
+JOSE
+----

 .. automodule:: acme.jose
   :members:

+.. toctree::
+   :glob:

-JSON Web Algorithms
-------------------
-
-.. automodule:: acme.jose.jwa
-   :members:
-
-
-JSON Web Key
------------
-
-.. automodule:: acme.jose.jwk
-   :members:
-
-
-JSON Web Signature
------------------
-
-.. automodule:: acme.jose.jws
-   :members:
-
-
-Implementation details
----------------------
-
-
-Interfaces
-~~~~~~~~~~
-
-.. automodule:: acme.jose.interfaces
-   :members:
-
-
-Errors
-~~~~~~
-
-.. automodule:: acme.jose.errors
-   :members:
-
-
-JSON utilities
-~~~~~~~~~~~~~~
-
-.. automodule:: acme.jose.json_util
-   :members:
-
-
-JOSE Base64
-~~~~~~~~~~~
-
-.. automodule:: acme.jose.b64
-   :members:
-
-
-Utilities
-~~~~~~~~~
-
-.. automodule:: acme.jose.util
-   :members:
+   jose/*
@@ -0,0 +1,5 @@
+JOSE Base64
+-----------
+
+.. automodule:: acme.jose.b64
+   :members:
@@ -0,0 +1,5 @@
+Errors
+------
+
+.. automodule:: acme.jose.errors
+   :members:
@@ -0,0 +1,5 @@
+Interfaces
+----------
+
+.. automodule:: acme.jose.interfaces
+   :members:
@@ -0,0 +1,5 @@
+JSON utilities
+--------------
+
+.. automodule:: acme.jose.json_util
+   :members:
@@ -0,0 +1,5 @@
+JSON Web Algorithms
+-------------------
+
+.. automodule:: acme.jose.jwa
+   :members:
@@ -0,0 +1,5 @@
+JSON Web Key
+------------
+
+.. automodule:: acme.jose.jwk
+   :members:
@@ -0,0 +1,5 @@
+JSON Web Signature
+------------------
+
+.. automodule:: acme.jose.jws
+   :members:
@@ -0,0 +1,5 @@
+Utilities
+---------
+
+.. automodule:: acme.jose.util
+   :members: