summaryrefslogtreecommitdiff
path: root/docs/api/leap.crypto.rst
diff options
context:
space:
mode:
authorkali <kali@leap.se>2013-05-03 02:59:22 +0900
committerkali <kali@leap.se>2013-05-03 02:59:22 +0900
commit96eaddedd7f09fcbcc390aedd7078aeecfa4c885 (patch)
tree90cd8f5de56207be3a2863dfd728189339f2931c /docs/api/leap.crypto.rst
parent90cac3e4a992a513db96b6c126fdd5259e881d0f (diff)
updated documentation
* documentation reviewed after rewrite, ready for 0.2.1 * updated docstrings format to fit sphinx autodoc
Diffstat (limited to 'docs/api/leap.crypto.rst')
-rw-r--r--docs/api/leap.crypto.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/api/leap.crypto.rst b/docs/api/leap.crypto.rst
new file mode 100644
index 00000000..6db77e86
--- /dev/null
+++ b/docs/api/leap.crypto.rst
@@ -0,0 +1,34 @@
+crypto Package
+==============
+
+:mod:`constants` Module
+-----------------------
+
+.. automodule:: leap.crypto.constants
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`srpauth` Module
+---------------------
+
+.. automodule:: leap.crypto.srpauth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`srpregister` Module
+-------------------------
+
+.. automodule:: leap.crypto.srpregister
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ leap.crypto.tests
+