From b74658ec6e752e9a510434af23ffad69ed7e4f93 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 17:09:22 -0600 Subject: doc updates --- docs/changelog.rst | 5 +++-- docs/hazmat/backends/common-crypto.rst | 20 -------------------- docs/hazmat/backends/commoncrypto.rst | 20 ++++++++++++++++++++ docs/hazmat/backends/index.rst | 2 +- 4 files changed, 24 insertions(+), 23 deletions(-) delete mode 100644 docs/hazmat/backends/common-crypto.rst create mode 100644 docs/hazmat/backends/commoncrypto.rst (limited to 'docs') diff --git a/docs/changelog.rst b/docs/changelog.rst index 82d3bf05..819b426a 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,10 +6,11 @@ Changelog **In development** -* Added CommonCrypto backend with hash and HMAC support. -* Added initial CommonCrypto bindings. +* Added :doc:`/hazmat/backends/commoncrypto` with hash and HMAC support. +* Added initial :doc:`/hazmat/bindings/commoncrypto`. 0.1 - 2014-01-08 ~~~~~~~~~~~~~~~~ * Initial release. + diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst deleted file mode 100644 index af2032b6..00000000 --- a/docs/hazmat/backends/common-crypto.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. hazmat:: - -CommonCrypto Backend -==================== - -The `CommonCrypto`_ C library provided by Apple on OS X and iOS. - -.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend - -.. versionadded:: 0.2 - -.. data:: cryptography.hazmat.backends.commoncrypto.backend - - This is the exposed API for the CommonCrypto backend. It has one public attribute. - - .. attribute:: name - - The string name of this backend: ``"commoncrypto"`` - -.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst new file mode 100644 index 00000000..af2032b6 --- /dev/null +++ b/docs/hazmat/backends/commoncrypto.rst @@ -0,0 +1,20 @@ +.. hazmat:: + +CommonCrypto Backend +==================== + +The `CommonCrypto`_ C library provided by Apple on OS X and iOS. + +.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend + +.. versionadded:: 0.2 + +.. data:: cryptography.hazmat.backends.commoncrypto.backend + + This is the exposed API for the CommonCrypto backend. It has one public attribute. + + .. attribute:: name + + The string name of this backend: ``"commoncrypto"`` + +.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst index 22354f69..dbc0724e 100644 --- a/docs/hazmat/backends/index.rst +++ b/docs/hazmat/backends/index.rst @@ -31,5 +31,5 @@ Individual Backends :maxdepth: 1 openssl - common-crypto + commoncrypto interfaces -- cgit v1.2.3