diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-02 10:55:36 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-02 10:55:36 -0800 |
| commit | 5bae063ff2601db15d84920f18bae194bcd3d373 (patch) | |
| tree | b6c39a3f84b434ae26245fcda6abe6c1e4165156 /docs/index.rst | |
| parent | 09aa74635f54ace5480a6d502b0da92651f516b6 (diff) | |
| parent | a6d5d6ec53da5bea0193047c5e535a05442f2dfd (diff) | |
| download | cryptography-5bae063ff2601db15d84920f18bae194bcd3d373.tar.gz cryptography-5bae063ff2601db15d84920f18bae194bcd3d373.tar.bz2 cryptography-5bae063ff2601db15d84920f18bae194bcd3d373.zip | |
Merge branch 'master' into fernet
Conflicts:
docs/index.rst
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index 72711174..9682337c 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. @@ -55,7 +57,6 @@ The recipes layer :maxdepth: 2 fernet - architecture exceptions glossary @@ -67,6 +68,7 @@ The hazardous materials layer hazmat/primitives/index hazmat/backends/index + hazmat/bindings/index The ``cryptography`` open source project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |