Skip to content

Commit

Permalink
Add store api reference
Browse files Browse the repository at this point in the history
  • Loading branch information
kylebarron committed Feb 28, 2025
1 parent f069ddf commit da1a5ef
Show file tree
Hide file tree
Showing 9 changed files with 64 additions and 0 deletions.
11 changes: 11 additions & 0 deletions python/docs/api/store/aws.md
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions python/docs/api/store/azure.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions python/docs/api/store/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Configuration

::: async_tiff.store.ClientConfig
::: async_tiff.store.BackoffConfig
::: async_tiff.store.RetryConfig
11 changes: 11 additions & 0 deletions python/docs/api/store/gcs.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions python/docs/api/store/http.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# HTTP

::: async_tiff.store.HTTPStore
4 changes: 4 additions & 0 deletions python/docs/api/store/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# ObjectStore

::: async_tiff.store.from_url
::: async_tiff.store.ObjectStore
3 changes: 3 additions & 0 deletions python/docs/api/store/local.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Local

::: async_tiff.store.LocalStore
3 changes: 3 additions & 0 deletions python/docs/api/store/memory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Memory

::: async_tiff.store.MemoryStore
10 changes: 10 additions & 0 deletions python/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit da1a5ef

Please sign in to comment.