From ca464c25fbe15d197938142af690ba6c0d32e379 Mon Sep 17 00:00:00 2001 From: Jakub Warmuz Date: Sun, 18 Oct 2015 16:10:21 +0000 Subject: [PATCH] Split JOSE API docs --- acme/docs/api.rst | 2 +- acme/docs/api/jose.rst | 67 +++---------------------------- acme/docs/api/jose/base64.rst | 5 +++ acme/docs/api/jose/errors.rst | 5 +++ acme/docs/api/jose/interfaces.rst | 5 +++ acme/docs/api/jose/json_util.rst | 5 +++ acme/docs/api/jose/jwa.rst | 5 +++ acme/docs/api/jose/jwk.rst | 5 +++ acme/docs/api/jose/jws.rst | 5 +++ acme/docs/api/jose/util.rst | 5 +++ 10 files changed, 46 insertions(+), 63 deletions(-) create mode 100644 acme/docs/api/jose/base64.rst create mode 100644 acme/docs/api/jose/errors.rst create mode 100644 acme/docs/api/jose/interfaces.rst create mode 100644 acme/docs/api/jose/json_util.rst create mode 100644 acme/docs/api/jose/jwa.rst create mode 100644 acme/docs/api/jose/jwk.rst create mode 100644 acme/docs/api/jose/jws.rst create mode 100644 acme/docs/api/jose/util.rst diff --git a/acme/docs/api.rst b/acme/docs/api.rst index 8668ec5d8..c874d8470 100644 --- a/acme/docs/api.rst +++ b/acme/docs/api.rst @@ -5,4 +5,4 @@ API Documentation .. toctree:: :glob: - api/** + api/* diff --git a/acme/docs/api/jose.rst b/acme/docs/api/jose.rst index fa3a0e9bb..0f7dd627c 100644 --- a/acme/docs/api/jose.rst +++ b/acme/docs/api/jose.rst @@ -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/* diff --git a/acme/docs/api/jose/base64.rst b/acme/docs/api/jose/base64.rst new file mode 100644 index 000000000..a40f8b11b --- /dev/null +++ b/acme/docs/api/jose/base64.rst @@ -0,0 +1,5 @@ +JOSE Base64 +----------- + +.. automodule:: acme.jose.b64 + :members: diff --git a/acme/docs/api/jose/errors.rst b/acme/docs/api/jose/errors.rst new file mode 100644 index 000000000..60d9b5c78 --- /dev/null +++ b/acme/docs/api/jose/errors.rst @@ -0,0 +1,5 @@ +Errors +------ + +.. automodule:: acme.jose.errors + :members: diff --git a/acme/docs/api/jose/interfaces.rst b/acme/docs/api/jose/interfaces.rst new file mode 100644 index 000000000..7b72b364f --- /dev/null +++ b/acme/docs/api/jose/interfaces.rst @@ -0,0 +1,5 @@ +Interfaces +---------- + +.. automodule:: acme.jose.interfaces + :members: diff --git a/acme/docs/api/jose/json_util.rst b/acme/docs/api/jose/json_util.rst new file mode 100644 index 000000000..f06edead2 --- /dev/null +++ b/acme/docs/api/jose/json_util.rst @@ -0,0 +1,5 @@ +JSON utilities +-------------- + +.. automodule:: acme.jose.json_util + :members: diff --git a/acme/docs/api/jose/jwa.rst b/acme/docs/api/jose/jwa.rst new file mode 100644 index 000000000..c858a5d1d --- /dev/null +++ b/acme/docs/api/jose/jwa.rst @@ -0,0 +1,5 @@ +JSON Web Algorithms +------------------- + +.. automodule:: acme.jose.jwa + :members: diff --git a/acme/docs/api/jose/jwk.rst b/acme/docs/api/jose/jwk.rst new file mode 100644 index 000000000..8e6bbe13f --- /dev/null +++ b/acme/docs/api/jose/jwk.rst @@ -0,0 +1,5 @@ +JSON Web Key +------------ + +.. automodule:: acme.jose.jwk + :members: diff --git a/acme/docs/api/jose/jws.rst b/acme/docs/api/jose/jws.rst new file mode 100644 index 000000000..15335bf8f --- /dev/null +++ b/acme/docs/api/jose/jws.rst @@ -0,0 +1,5 @@ +JSON Web Signature +------------------ + +.. automodule:: acme.jose.jws + :members: diff --git a/acme/docs/api/jose/util.rst b/acme/docs/api/jose/util.rst new file mode 100644 index 000000000..41cbbcc31 --- /dev/null +++ b/acme/docs/api/jose/util.rst @@ -0,0 +1,5 @@ +Utilities +--------- + +.. automodule:: acme.jose.util + :members: