Skip to content

Commit 78d2876

Browse files
authored
Add Python docs (#39)
* Python docs * Add store api reference * hide social plugin for now * Pin griffe
1 parent ed67b77 commit 78d2876

File tree

15 files changed

+289
-5
lines changed

15 files changed

+289
-5
lines changed

python/docs/api/store/aws.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AWS S3
2+
3+
::: async_tiff.store.S3Store
4+
::: async_tiff.store.S3ConfigInput
5+
options:
6+
show_if_no_docstring: true
7+
::: async_tiff.store.S3Config
8+
options:
9+
show_if_no_docstring: true
10+
::: async_tiff.store.S3Credential
11+
::: async_tiff.store.S3CredentialProvider

python/docs/api/store/azure.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Microsoft Azure
2+
3+
::: async_tiff.store.AzureStore
4+
::: async_tiff.store.AzureAccessKey
5+
::: async_tiff.store.AzureConfigInput
6+
options:
7+
show_if_no_docstring: true
8+
::: async_tiff.store.AzureConfig
9+
options:
10+
show_if_no_docstring: true
11+
::: async_tiff.store.AzureSASToken
12+
::: async_tiff.store.AzureBearerToken
13+
::: async_tiff.store.AzureCredential
14+
::: async_tiff.store.AzureCredentialProvider

python/docs/api/store/config.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Configuration
2+
3+
::: async_tiff.store.ClientConfig
4+
::: async_tiff.store.BackoffConfig
5+
::: async_tiff.store.RetryConfig

python/docs/api/store/gcs.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Google Cloud Storage
2+
3+
::: async_tiff.store.GCSStore
4+
::: async_tiff.store.GCSConfigInput
5+
options:
6+
show_if_no_docstring: true
7+
::: async_tiff.store.GCSConfig
8+
options:
9+
show_if_no_docstring: true
10+
::: async_tiff.store.GCSCredential
11+
::: async_tiff.store.GCSCredentialProvider

python/docs/api/store/http.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# HTTP
2+
3+
::: async_tiff.store.HTTPStore

python/docs/api/store/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# ObjectStore
2+
3+
::: async_tiff.store.from_url
4+
::: async_tiff.store.ObjectStore

python/docs/api/store/local.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Local
2+
3+
::: async_tiff.store.LocalStore

python/docs/api/store/memory.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Memory
2+
3+
::: async_tiff.store.MemoryStore

python/docs/assets/logo_no_text.png

4.53 KB
Loading

python/docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

0 commit comments

Comments
 (0)