diff --git a/python/docs/api/store/aws.md b/python/docs/api/store/aws.md new file mode 100644 index 0000000..d72fbc4 --- /dev/null +++ b/python/docs/api/store/aws.md @@ -0,0 +1,11 @@ +# AWS S3 + +::: async_tiff.store.S3Store +::: async_tiff.store.S3ConfigInput + options: + show_if_no_docstring: true +::: async_tiff.store.S3Config + options: + show_if_no_docstring: true +::: async_tiff.store.S3Credential +::: async_tiff.store.S3CredentialProvider diff --git a/python/docs/api/store/azure.md b/python/docs/api/store/azure.md new file mode 100644 index 0000000..eec88e9 --- /dev/null +++ b/python/docs/api/store/azure.md @@ -0,0 +1,14 @@ +# Microsoft Azure + +::: async_tiff.store.AzureStore +::: async_tiff.store.AzureAccessKey +::: async_tiff.store.AzureConfigInput + options: + show_if_no_docstring: true +::: async_tiff.store.AzureConfig + options: + show_if_no_docstring: true +::: async_tiff.store.AzureSASToken +::: async_tiff.store.AzureBearerToken +::: async_tiff.store.AzureCredential +::: async_tiff.store.AzureCredentialProvider diff --git a/python/docs/api/store/config.md b/python/docs/api/store/config.md new file mode 100644 index 0000000..bba4bbb --- /dev/null +++ b/python/docs/api/store/config.md @@ -0,0 +1,5 @@ +# Configuration + +::: async_tiff.store.ClientConfig +::: async_tiff.store.BackoffConfig +::: async_tiff.store.RetryConfig diff --git a/python/docs/api/store/gcs.md b/python/docs/api/store/gcs.md new file mode 100644 index 0000000..d395e33 --- /dev/null +++ b/python/docs/api/store/gcs.md @@ -0,0 +1,11 @@ +# Google Cloud Storage + +::: async_tiff.store.GCSStore +::: async_tiff.store.GCSConfigInput + options: + show_if_no_docstring: true +::: async_tiff.store.GCSConfig + options: + show_if_no_docstring: true +::: async_tiff.store.GCSCredential +::: async_tiff.store.GCSCredentialProvider diff --git a/python/docs/api/store/http.md b/python/docs/api/store/http.md new file mode 100644 index 0000000..dbeff69 --- /dev/null +++ b/python/docs/api/store/http.md @@ -0,0 +1,3 @@ +# HTTP + +::: async_tiff.store.HTTPStore diff --git a/python/docs/api/store/index.md b/python/docs/api/store/index.md new file mode 100644 index 0000000..f3b588d --- /dev/null +++ b/python/docs/api/store/index.md @@ -0,0 +1,4 @@ +# ObjectStore + +::: async_tiff.store.from_url +::: async_tiff.store.ObjectStore diff --git a/python/docs/api/store/local.md b/python/docs/api/store/local.md new file mode 100644 index 0000000..ec6ba35 --- /dev/null +++ b/python/docs/api/store/local.md @@ -0,0 +1,3 @@ +# Local + +::: async_tiff.store.LocalStore diff --git a/python/docs/api/store/memory.md b/python/docs/api/store/memory.md new file mode 100644 index 0000000..11bb15f --- /dev/null +++ b/python/docs/api/store/memory.md @@ -0,0 +1,3 @@ +# Memory + +::: async_tiff.store.MemoryStore diff --git a/python/mkdocs.yml b/python/mkdocs.yml index 8d4fca3..f466c1d 100644 --- a/python/mkdocs.yml +++ b/python/mkdocs.yml @@ -22,6 +22,16 @@ extra: nav: - "index.md" + - API Reference: + - async-tiff.store: + - api/store/index.md + - api/store/aws.md + - api/store/gcs.md + - api/store/azure.md + - api/store/http.md + - api/store/local.md + - api/store/memory.md + - api/store/config.md # - API Reference: # - api/rtree.md # - api/kdtree.md