Split JOSE API docs

This commit is contained in:
Jakub Warmuz 2015-10-18 16:10:21 +00:00 committed by Peter Eckersley
parent 5b757bdff2
commit ca464c25fb
10 changed files with 46 additions and 63 deletions

View file

@ -5,4 +5,4 @@ API Documentation
.. toctree::
:glob:
api/**
api/*

View file

@ -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/*

View file

@ -0,0 +1,5 @@
JOSE Base64
-----------
.. automodule:: acme.jose.b64
:members:

View file

@ -0,0 +1,5 @@
Errors
------
.. automodule:: acme.jose.errors
:members:

View file

@ -0,0 +1,5 @@
Interfaces
----------
.. automodule:: acme.jose.interfaces
:members:

View file

@ -0,0 +1,5 @@
JSON utilities
--------------
.. automodule:: acme.jose.json_util
:members:

View file

@ -0,0 +1,5 @@
JSON Web Algorithms
-------------------
.. automodule:: acme.jose.jwa
:members:

View file

@ -0,0 +1,5 @@
JSON Web Key
------------
.. automodule:: acme.jose.jwk
:members:

View file

@ -0,0 +1,5 @@
JSON Web Signature
------------------
.. automodule:: acme.jose.jws
:members:

View file

@ -0,0 +1,5 @@
Utilities
---------
.. automodule:: acme.jose.util
:members: