diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-01 09:13:52 -0800 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-01 09:13:52 -0800 |
| commit | 2fe6456b93a245f2fb4ff062ff0316e8b0e8f4c8 (patch) | |
| tree | bd567da2eb52de37471133f0538c97b9fe298e1a /docs | |
| parent | 522487e5a7dd3004747da85c9f6c53fc5dc4de06 (diff) | |
| parent | 73cd6276884f1e2828adc948fe4baa4b93dc78ed (diff) | |
| download | cryptography-2fe6456b93a245f2fb4ff062ff0316e8b0e8f4c8.tar.gz cryptography-2fe6456b93a245f2fb4ff062ff0316e8b0e8f4c8.tar.bz2 cryptography-2fe6456b93a245f2fb4ff062ff0316e8b0e8f4c8.zip | |
Merge pull request #384 from alex/better-docs
This page has been subsumed by the index
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 13 | ||||
| -rw-r--r-- | docs/index.rst | 5 |
2 files changed, 3 insertions, 15 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst deleted file mode 100644 index bacde1bb..00000000 --- a/docs/architecture.rst +++ /dev/null @@ -1,13 +0,0 @@ -Architecture -============ - -``cryptography`` has three different layers: - -* ``cryptography``: This package contains higher level recipes, for example - "encrypt and then MAC". This is implemented on top of - ``cryptography.hazmat.primitives``. -* ``cryptography.hazmat.primitives``: This packages contains low level - algorithms, things like ``AES`` or ``SHA1``. This is implemented on top of - ``cryptography.hazmat.backends``. -* ``cryptography.hazmat.backends``: This package contains bindings to low level - cryptographic libraries. Our initial target is OpenSSL. diff --git a/docs/index.rst b/docs/index.rst index 70558bda..9939182f 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 |