add CryptoConfig to rendered docs

mattsb42-aws · mattsb42-aws · commit 199742ce150d · 2018-05-02T11:27:08.000-07:00
diff --git a/doc/index.rst b/doc/index.rst
@@ -7,6 +7,7 @@ API
    :maxdepth: 2
    :caption: Encryption Helpers
 
+   lib/encrypted/config.rst
    lib/encrypted/helpers
    lib/encrypted/item
 
diff --git a/doc/lib/encrypted/config.rst b/doc/lib/encrypted/config.rst
@@ -0,0 +1,4 @@
+Cryptographic Configuration
+---------------------------
+
+.. automodule:: dynamodb_encryption_sdk.encrypted
diff --git a/src/dynamodb_encryption_sdk/encrypted/__init__.py b/src/dynamodb_encryption_sdk/encrypted/__init__.py
@@ -32,7 +32,8 @@
 
 @attr.s(init=False)
 class CryptoConfig(object):
-    """Container for all configuration needed to encrypt or decrypt an item.
+    """Container for all configuration needed to encrypt or decrypt an item using the item
+    encryptor functions in :py:mod:`dynamodb_encryption_sdk.encrypted.item`.
 
     :param CryptographicMaterialsProvider materials_provider: Cryptographic materials provider
         to use

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +Cryptographic Configuration
 +---------------------------
++
 +.. automodule:: dynamodb_encryption_sdk.encrypted