summaryrefslogtreecommitdiff
path: root/docs/lib/passlib.context-interface.rst
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-03-28 00:18:09 -0400
committerEli Collins <elic@assurancetechnologies.com>2011-03-28 00:18:09 -0400
commit9b489fc7045b756ca1c1b999a2ca120fe2394e92 (patch)
tree4fe5dbb18f8481055f3264a8b3d99d40c337ec0e /docs/lib/passlib.context-interface.rst
parenteeb244787205ba1139ad8cf971bfd939af8bbbd0 (diff)
downloadpasslib-9b489fc7045b756ca1c1b999a2ca120fe2394e92.tar.gz
CryptContext documentation: split interface listing to separate file; added large amount of integration example code
Diffstat (limited to 'docs/lib/passlib.context-interface.rst')
-rw-r--r--docs/lib/passlib.context-interface.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/lib/passlib.context-interface.rst b/docs/lib/passlib.context-interface.rst
new file mode 100644
index 0000000..372dd98
--- /dev/null
+++ b/docs/lib/passlib.context-interface.rst
@@ -0,0 +1,22 @@
+.. index:: CryptContext; interface
+
+.. _cryptcontext-interface:
+
+===============================================
+:mod:`passlib.context` - CryptContext Interface
+===============================================
+
+.. currentmodule:: passlib.context
+
+This details all the constructors and methods provided by :class:`!CryptContext`
+and :class:`!CryptPolicy`.
+
+.. seealso::
+
+ * :doc:`passlib.context-options` -- for a list of all the keyword options accepted by these classes.
+
+ * :doc:`passlib.context` -- for an overview and some usage examples.
+
+.. autoclass:: CryptContext(schemes=None, policy=<default policy>, \*\*kwds)
+
+.. autoclass:: CryptPolicy(\*\*kwds)