diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2013-12-24 13:50:11 -0800 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2013-12-24 13:50:11 -0800 |
| commit | 5d116f426d702f52be29e68d882e6336da57f6ee (patch) | |
| tree | f9fbd1c5a72271ee9c5eb9ff4f1fd84808c2fc20 | |
| parent | c4088fbe900c336a86bd82409f566d3be75e51bd (diff) | |
| parent | 8f42fe4e86267c4dee696707ac08371a1aa2531a (diff) | |
| download | cryptography-5d116f426d702f52be29e68d882e6336da57f6ee.tar.gz cryptography-5d116f426d702f52be29e68d882e6336da57f6ee.tar.bz2 cryptography-5d116f426d702f52be29e68d882e6336da57f6ee.zip | |
Merge pull request #342 from alex/reorganize-backend-docs
Slightly reorganize and cleanuip the backend docs
| -rw-r--r-- | docs/hazmat/backends/index.rst | 24 | ||||
| -rw-r--r-- | docs/hazmat/backends/openssl.rst | 4 |
2 files changed, 14 insertions, 14 deletions
diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst index a89cf0d5..06951281 100644 --- a/docs/hazmat/backends/index.rst +++ b/docs/hazmat/backends/index.rst @@ -1,17 +1,10 @@ .. hazmat:: -Bindings +Backends ======== -.. toctree:: - :maxdepth: 1 - - openssl - interfaces - - -Getting a Backend Provider -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Getting a Backend +----------------- .. currentmodule:: cryptography.hazmat.backends @@ -19,8 +12,7 @@ Getting a Backend Provider the widest number of supported cryptographic algorithms as well as supporting platform specific implementations. -You can get the default backend by calling -:func:`~default_backend`. +You can get the default backend by calling :func:`~default_backend`. The default backend will change over time as we implement new backends and the libraries we use in those backends changes. @@ -32,3 +24,11 @@ the libraries we use in those backends changes. :class:`~interfaces.CipherBackend`, :class:`~interfaces.HashBackend`, and :class:`~interfaces.HMACBackend`. +Individual Backends +------------------- + +.. toctree:: + :maxdepth: 1 + + openssl + interfaces diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 12fbff04..5e51c75e 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -1,7 +1,7 @@ .. hazmat:: -OpenSSL -======= +OpenSSL Backend +=============== These are `CFFI`_ bindings to the `OpenSSL`_ C library. |