aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-01 23:52:09 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-01 23:52:09 -0600
commitb8dbb89676836db16272e0485086191263f98c45 (patch)
treea0533b10b3abdd3a9854557c9344d83e3df72c79 /docs/index.rst
parent607688cdcb5b262715bd4eb70f9770f0326ce9e5 (diff)
parentfa3d5aacd9d8047467ef4f7aaec45fd69ba4fb59 (diff)
downloadcryptography-b8dbb89676836db16272e0485086191263f98c45.tar.gz
cryptography-b8dbb89676836db16272e0485086191263f98c45.tar.bz2
cryptography-b8dbb89676836db16272e0485086191263f98c45.zip
Merge branch 'master' into urandom-engine
* master: Split OpenSSL binding Fixed test for earlier exceptino Rearrange Move GCM tag size/value validation farther forward -- this makes it easier by not requiring future backends to implement the same checks expose num_locks and {get,set}_{id,locking}_callback Make the PyPy tox job consistent with the main one. THis should be a seperate PR Typo fix This page has been subsumed by the index Bump the copyright year Document compiling OpenSSL to avoid conflicts Conflicts: cryptography/hazmat/backends/openssl/backend.py
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 70558bda..5eb3de7d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -43,7 +43,9 @@ The other level is low-level cryptographic primitives. These are often
dangerous and can be used incorrectly. They require making decisions and having
an in-depth knowledge of the cryptographic concepts at work. Because of the
potential danger in working at this level, this is referred to as the
-"hazardous materials" or "hazmat" layer.
+"hazardous materials" or "hazmat" layer. These live in the
+``cryptography.hazmat`` package, and their documentation will always contain an
+admonition at the top.
We recommend using the recipes layer whenever possible, and falling back to the
hazmat layer only when necessary.
@@ -54,7 +56,6 @@ The recipes layer
.. toctree::
:maxdepth: 2
- architecture
exceptions
glossary
@@ -66,6 +67,7 @@ The hazardous materials layer
hazmat/primitives/index
hazmat/backends/index
+ hazmat/bindings/index
The ``cryptography`` open source project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~