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-11 21:59:58 +0900
commit2dae2703fb8c2ae7e721ce83020c0dd10ff9ca33 (patch)
tree280cb8751c56d43769fb15ead4fb4476960ae06c /docs/api/leap.crypto.rst
parentc85894efdbd6f65eb2b0c2edfc216827c192c1d1 (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
+