initial draft of more human-navigable docs

mattsb42-aws · praus · commit 43f4b4508bea · 2018-05-02T13:10:38.000-07:00
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,3 +1,7 @@
+#####################################
+DynamoDB Encryption Client for Python
+#####################################
+
 .. include:: ../README.rst
 
 ***
diff --git a/doc/lib/encrypted/dynamodb_encryption_sdk.encrypted.client.rst b/doc/lib/encrypted/dynamodb_encryption_sdk.encrypted.client.rst
@@ -0,0 +1,23 @@
+dynamodb\_encryption\_sdk.encrypted.client
+==========================================
+
+.. automodule:: dynamodb_encryption_sdk.encrypted.client
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      EncryptedClient
+      EncryptedPaginator
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/encrypted/dynamodb_encryption_sdk.encrypted.resource.rst b/doc/lib/encrypted/dynamodb_encryption_sdk.encrypted.resource.rst
@@ -0,0 +1,23 @@
+dynamodb\_encryption\_sdk.encrypted.resource
+============================================
+
+.. automodule:: dynamodb_encryption_sdk.encrypted.resource
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      EncryptedResource
+      EncryptedTablesCollectionManager
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/encrypted/dynamodb_encryption_sdk.encrypted.table.rst b/doc/lib/encrypted/dynamodb_encryption_sdk.encrypted.table.rst
@@ -0,0 +1,22 @@
+dynamodb\_encryption\_sdk.encrypted.table
+=========================================
+
+.. automodule:: dynamodb_encryption_sdk.encrypted.table
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      EncryptedTable
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/encrypted/index.rst b/doc/lib/encrypted/index.rst
@@ -0,0 +1,4 @@
+.. toctree::
+
+   helpers
+   item
diff --git a/doc/lib/internal.rst b/doc/lib/internal.rst
@@ -9,6 +9,7 @@ Internal Resources
 .. autosummary::
    :toctree: generated
 
+
     dynamodb_encryption_sdk.internal.identifiers
     dynamodb_encryption_sdk.internal.str_ops
     dynamodb_encryption_sdk.internal.utils
diff --git a/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.aws_kms.rst b/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.aws_kms.rst
@@ -0,0 +1,25 @@
+dynamodb\_encryption\_sdk.material\_providers.aws\_kms
+======================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.aws_kms
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AwsKmsCryptographicMaterialsProvider
+      EncryptionContextKeys
+      HkdfInfo
+      KeyInfo
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.most_recent.rst b/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.most_recent.rst
@@ -0,0 +1,24 @@
+dynamodb\_encryption\_sdk.material\_providers.most\_recent
+==========================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.most_recent
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      BasicCache
+      MostRecentProvider
+      TtlActions
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.rst b/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.rst
@@ -0,0 +1,22 @@
+dynamodb\_encryption\_sdk.material\_providers
+=============================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      CryptographicMaterialsProvider
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.static.rst b/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.static.rst
@@ -0,0 +1,22 @@
+dynamodb\_encryption\_sdk.material\_providers.static
+====================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.static
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      StaticCryptographicMaterialsProvider
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.store.meta.rst b/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.store.meta.rst
@@ -0,0 +1,24 @@
+dynamodb\_encryption\_sdk.material\_providers.store.meta
+========================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.store.meta
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      MetaStore
+      MetaStoreAttributeNames
+      MetaStoreValues
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.store.rst b/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.store.rst
@@ -0,0 +1,22 @@
+dynamodb\_encryption\_sdk.material\_providers.store
+===================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.store
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      ProviderStore
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.wrapped.rst b/doc/lib/materials_providers/TEST/dynamodb_encryption_sdk.material_providers.wrapped.rst
@@ -0,0 +1,22 @@
+dynamodb\_encryption\_sdk.material\_providers.wrapped
+=====================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.wrapped
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      WrappedCryptographicMaterialsProvider
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.aws_kms.rst b/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.aws_kms.rst
@@ -0,0 +1,25 @@
+dynamodb\_encryption\_sdk.material\_providers.aws\_kms
+======================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.aws_kms
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AwsKmsCryptographicMaterialsProvider
+      EncryptionContextKeys
+      HkdfInfo
+      KeyInfo
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.most_recent.rst b/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.most_recent.rst
@@ -0,0 +1,24 @@
+dynamodb\_encryption\_sdk.material\_providers.most\_recent
+==========================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.most_recent
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      BasicCache
+      MostRecentProvider
+      TtlActions
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.rst b/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.rst
@@ -0,0 +1,22 @@
+dynamodb\_encryption\_sdk.material\_providers
+=============================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      CryptographicMaterialsProvider
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.static.rst b/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.static.rst
@@ -0,0 +1,22 @@
+dynamodb\_encryption\_sdk.material\_providers.static
+====================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.static
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      StaticCryptographicMaterialsProvider
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.store.meta.rst b/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.store.meta.rst
@@ -0,0 +1,24 @@
+dynamodb\_encryption\_sdk.material\_providers.store.meta
+========================================================
+
+.. automodule:: dynamodb_encryption_sdk.material_providers.store.meta
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      MetaStore
+      MetaStoreAttributeNames
+      MetaStoreValues
+   
+   
+
+   
+   
+   
diff --git a/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.store.rst b/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.store.rst
diff --git a/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.wrapped.rst b/doc/lib/materials_providers/dynamodb_encryption_sdk.material_providers.wrapped.rst
diff --git a/doc/lib/materials_providers/metastore.rst b/doc/lib/materials_providers/metastore.rst

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.. toctree::
++
 +   helpers
 +   item