acme.jose: (Typed)JSONObjectWithFields, Field, JWA.

.pylintrc

@@ -38,7 +38,8 @@ load-plugins=linter_plugin
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=fixme,locally-disabled
+disable=fixme,locally-disabled,abstract-class-not-used
+# abstract-class-not-used cannot be disabled locally (at least in pylint 1.4.1)
 
 
 [REPORTS]
@@ -148,10 +149,10 @@ module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 
 # Regular expression matching correct method names
-method-rgx=[a-z_][a-z0-9_]{2,40}$
+method-rgx=[a-z_][a-z0-9_]{2,50}$
 
 # Naming hint for method names
-method-name-hint=[a-z_][a-z0-9_]{2,40}$
+method-name-hint=[a-z_][a-z0-9_]{2,50}$
 
 # Regular expression which should only match function or class names that do
 # not require a docstring.
@@ -311,7 +312,7 @@ max-branches=12
 max-statements=50
 
 # Maximum number of parents for a class (see R0901).
-max-parents=7
+max-parents=12
 
 # Maximum number of attributes for a class (see R0902).
 max-attributes=7

docs/api/acme.rst → docs/api/acme/index.rst

@@ -5,12 +5,6 @@
    :members:
 
 
-Interfaces
-----------
-
-.. automodule:: letsencrypt.acme.interfaces
-   :members:
-
 Messages
 --------
 
@@ -46,6 +40,3 @@ Utilities
 
 .. automodule:: letsencrypt.acme.util
    :members:
-
-.. automodule:: letsencrypt.acme.jose
-   :members:

docs/api/acme/jose.rst

@@ -0,0 +1,60 @@
+:mod:`letsencrypt.acme.jose`
+============================
+
+.. contents::
+
+.. automodule:: letsencrypt.acme.jose
+   :members:
+
+
+JSON Web Algorithms
+-------------------
+
+.. automodule:: letsencrypt.acme.jose.jwa
+   :members:
+
+
+JSON Web Key
+------------
+
+.. automodule:: letsencrypt.acme.jose.jwk
+   :members:
+
+
+Implementation details
+----------------------
+
+
+Interfaces
+~~~~~~~~~~
+
+.. automodule:: letsencrypt.acme.jose.interfaces
+   :members:
+
+
+Errors
+~~~~~~
+
+.. automodule:: letsencrypt.acme.jose.errors
+   :members:
+
+
+JSON utilities
+~~~~~~~~~~~~~~
+
+.. automodule:: letsencrypt.acme.jose.json_util
+   :members:
+
+
+JOSE Base64
+~~~~~~~~~~~
+
+.. automodule:: letsencrypt.acme.jose.b64
+   :members:
+
+
+Utilities
+~~~~~~~~~
+
+.. automodule:: letsencrypt.acme.jose.util
+   :members:

docs/conf.py

@@ -55,7 +55,7 @@
 ]
 
 autodoc_member_order = 'bysource'
-autodoc_default_flags = ['show-inheritance']
+autodoc_default_flags = ['show-inheritance', 'private-members']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']