diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-02 10:56:08 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-02 10:56:08 -0800 |
| commit | 267dbc946b4584b7b4ed10a439b2820d3b048356 (patch) | |
| tree | 45fea345889584b74496359496ba202cf4c60802 /docs/index.rst | |
| parent | 71e8ca0d79d8599f1f00d6ec18cb19a2ffabfc8d (diff) | |
| parent | a6d5d6ec53da5bea0193047c5e535a05442f2dfd (diff) | |
| download | cryptography-267dbc946b4584b7b4ed10a439b2820d3b048356.tar.gz cryptography-267dbc946b4584b7b4ed10a439b2820d3b048356.tar.bz2 cryptography-267dbc946b4584b7b4ed10a439b2820d3b048356.zip | |
Merge branch 'master' into validate-iv
Conflicts:
cryptography/hazmat/primitives/ciphers/modes.py
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 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |