Skip to content

Commit be4761a

Browse files
dankingdanking
authored
feat: teach docs about object store (#7169)
A user asked a question about object store today in Slack. When trying to answer that question, I realized our object store docs are garbage because they're all stored in pyi files which are not used by Sphinx. Hopefully you will excuse the hack I used here. I copied those docstrings over into real py files and sub-classed the actual native classes of interest. These non-native classes get documented as you expect and delegate their methods to their (native) super-classes. I forget why I updated Sphinx but it was due to something not rendering properly on our old version of Sphinx. --------- Signed-off-by: Daniel King <dan@spiraldb.com>
1 parent 1e0e6d0 commit be4761a

File tree

26 files changed

+1948
-136
lines changed

26 files changed

+1948
-136
lines changed

‎docs/api/python/store.rst‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
1+
====================
12
Object Store support
23
====================
34

4-
Vortex arrays support reading and writing to object storage systems such as, S3, Google Cloud Storage, and
5-
Azure Blob Storage.
6-
7-
.. autosummary::
8-
:nosignatures:
9-
10-
.. raw:: html
5+
Vortex arrays support reading and writing to many object storage systems:
116

12-
<hr>
7+
.. toctree::
8+
:maxdepth: 1
139

14-
.. automodule:: vortex.store
15-
:members:
16-
:imported-members:
10+
store/aws
11+
store/gcs
12+
store/azure
13+
store/http
14+
store/local
15+
store/memory
16+
store/config
1717

18+
.. autofunction:: vortex.store.from_url

‎docs/api/python/store/aws.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
====================
2+
S3 and S3-compatible
3+
====================
4+
5+
6+
.. autosummary::
7+
vortex.store.S3Store
8+
vortex.store.S3Config
9+
vortex.store.S3Credential
10+
vortex.store.S3CredentialProvider
11+
12+
.. autoclass:: vortex.store.S3Store
13+
:members:
14+
.. autoclass:: vortex.store.S3Config
15+
:members:
16+
.. autoclass:: vortex.store.S3Credential
17+
:members:
18+
.. autoclass:: vortex.store.S3CredentialProvider
19+
:members:
20+

‎docs/api/python/store/azure.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
==================
2+
Azure Blob Storage
3+
==================
4+
5+
.. autosummary::
6+
vortex.store.AzureStore
7+
vortex.store.AzureConfig
8+
vortex.store.AzureAccessKey
9+
vortex.store.AzureSASToken
10+
vortex.store.AzureBearerToken
11+
vortex.store.AzureCredential
12+
vortex.store.AzureCredentialProvider
13+
14+
15+
.. autoclass:: vortex.store.AzureStore
16+
:members:
17+
.. autoclass:: vortex.store.AzureConfig
18+
:members:
19+
.. autoclass:: vortex.store.AzureAccessKey
20+
:members:
21+
.. autoclass:: vortex.store.AzureSASToken
22+
:members:
23+
.. autoclass:: vortex.store.AzureBearerToken
24+
:members:
25+
.. autoclass:: vortex.store.AzureCredential
26+
:members:
27+
.. autoclass:: vortex.store.AzureCredentialProvider
28+
:members:
29+

‎docs/api/python/store/config.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
====================
2+
Common Configuration
3+
====================
4+
5+
.. autosummary::
6+
vortex.store.ClientConfig
7+
vortex.store.RetryConfig
8+
vortex.store.BackoffConfig
9+
10+
11+
.. autoclass:: vortex.store.ClientConfig
12+
:members:
13+
.. autoclass:: vortex.store.RetryConfig
14+
:members:
15+
.. autoclass:: vortex.store.BackoffConfig
16+
:members:

‎docs/api/python/store/gcs.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
====================
2+
Google Cloud Storage
3+
====================
4+
5+
.. autosummary::
6+
vortex.store.GCSStore
7+
vortex.store.GCSConfig
8+
vortex.store.GCSCredential
9+
vortex.store.GCSCredentialProvider
10+
11+
.. autoclass:: vortex.store.GCSStore
12+
:members:
13+
.. autoclass:: vortex.store.GCSConfig
14+
:members:
15+
.. autoclass:: vortex.store.GCSCredential
16+
:members:
17+
.. autoclass:: vortex.store.GCSCredentialProvider
18+
:members:

‎docs/api/python/store/http.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
====
2+
HTTP
3+
====
4+
5+
.. autoclass:: vortex.store.HTTPStore
6+
:members:

‎docs/api/python/store/local.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
=====
2+
Local
3+
=====
4+
5+
.. autoclass:: vortex.store.LocalStore
6+
:members:

‎docs/api/python/store/memory.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
======
2+
Memory
3+
======
4+
5+
.. autoclass:: vortex.store.MemoryStore
6+
:members:

‎docs/pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ dependencies = [
1212
"sphinx-copybutton>=0.5.2",
1313
"sphinx-design>=0.6.0",
1414
"sphinx-inline-tabs>=2023.4.21",
15-
"sphinx>=8.0.2",
15+
"sphinx>=9.0.0",
1616
"sphinxcontrib-bibtex>=2.6.3",
1717
"sphinxcontrib-mermaid>=1.0.0",
1818
"sphinxext-opengraph>=0.9.1",

‎uv.lock‎

Lines changed: 90 additions & 44 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)