Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitc8d8e64

Browse files
maxrjonesd-v-b
andauthored
Improve compatibility between old sphinx and new mkdocs setup (#3544)
* Add more redirects for sphinx->mkdocs migration* Add entry point for top-level API* Explicit setting* Add missing pages* Add redirects---------Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com>
1 parenteb1b6e8 commitc8d8e64

File tree

8 files changed

+108
-1
lines changed

8 files changed

+108
-1
lines changed

‎docs/api/abc/buffer.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,11 @@
22
title:buffer
33
---
44

5+
::: zarr.abc
6+
options:
7+
show_root_heading: true
8+
show_root_toc_entry: true
9+
members: false
10+
11+
512
::: zarr.abc.buffer

‎docs/api/abc/codec.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ title: codec
33
---
44

55
::: zarr.abc.codec
6+
::: zarr.abc.numcodec

‎docs/api/api_sync.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,10 @@
22
title:synchronous
33
---
44

5+
::: zarr.api
6+
options:
7+
show_root_heading: true
8+
show_root_toc_entry: true
9+
members: false
10+
511
::: zarr.api.synchronous

‎docs/api/codecs.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title:codecs
33
---
44

5-
::: zarr.codecs
5+
::: zarr.codecs
6+
7+
::: zarr.codecs.numcodecs

‎docs/api/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Complete reference documentation for the Zarr-Python API.
44

5+
::: zarr
6+
options:
7+
show_root_heading: true
8+
show_root_toc_entry: true
9+
members: false
10+
511
##Core API
612

713
###Essential Classes and Functions

‎docs/api/metadata.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title:metadata
3+
---
4+
5+
::: zarr.metadata
6+
::: zarr.metadata.migrate_v3

‎docs/api/testing.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
title:testing
33
---
44

5+
::: zarr.testing
6+
options:
7+
show_root_heading: true
8+
show_root_toc_entry: true
9+
members: false
10+
511
##Buffer
612

713
::: zarr.testing.buffer
@@ -21,3 +27,7 @@ title: testing
2127
##Utils
2228

2329
::: zarr.testing.utils
30+
31+
##Conftest
32+
33+
::: zarr.testing.conftest

‎mkdocs.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ site_description: An implementation of chunked, compressed, N-dimensional arrays
66
site_author:Alistair Miles
77
site_url:!ENV [READTHEDOCS_CANONICAL_URL, 'https://zarr.readthedocs.io/']
88
docs_dir:docs
9+
use_directory_urls:true
910

1011
nav:
1112
-"index.md"
@@ -42,6 +43,7 @@ nav:
4243
-api/config.md
4344
-api/codecs.md
4445
-api/errors.md
46+
-api/metadata.md
4547
-api/registry.md
4648
-api/storage.md
4749
-api/testing.md
@@ -130,6 +132,7 @@ plugins:
130132
show_source:true
131133
show_symbol_type_toc:true
132134
signature_crossrefs:true
135+
show_if_no_docstring:true
133136
extensions:
134137
-griffe_inherited_docstrings
135138

@@ -154,11 +157,77 @@ plugins:
154157
'spec/v2.md':'https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html'
155158
'spec/v3.md':'https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html'
156159
'license.md':'https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt'
160+
'genindex.html.md':'index.md'
161+
'py-modindex.html.md':'index.md'
162+
'search.html.md':'index.md'
157163
'tutorial.md':'user-guide/installation.md'
158164
'getting-started.md':'quick-start.md'
159165
'roadmap.md':'https://zarr.readthedocs.io/en/v3.0.8/developers/roadmap.html'
160166
'installation.md':'user-guide/installation.md'
161167
'release.md':'release-notes.md'
168+
'about.html.md':'index.md'
169+
'arrays.html.md':'user-guide/arrays.md'
170+
'attributes.html.md':'user-guide/attributes.md'
171+
'cli.html.md':'user-guide/cli.md'
172+
'config.html.md':'user-guide/config.md'
173+
'consolidated_metadata.html.md':'user-guide/consolidated_metadata.md'
174+
'data_types.html.md':'user-guide/data_types.md'
175+
'extending.html.md':'user-guide/extending.md'
176+
'gpu.html.md':'user-guide/gpu.md'
177+
'groups.html.md':'user-guide/groups.md'
178+
'installation.html.md':'user-guide/installation.md'
179+
'performance.html.md':'user-guide/performance.md'
180+
'quickstart.html.md':'quick-start.md'
181+
'release-notes.html.md':'release-notes.md'
182+
'storage.html.md':'user-guide/storage.md'
183+
'v3_migration.html.md':'user-guide/v3_migration.md'
184+
'user-guide/arrays.html.md':'user-guide/arrays.md'
185+
'user-guide/attributes.html.md':'user-guide/attributes.md'
186+
'user-guide/cli.html.md':'user-guide/cli.md'
187+
'user-guide/config.html.md':'user-guide/config.md'
188+
'user-guide/consolidated_metadata.html.md':'user-guide/consolidated_metadata.md'
189+
'user-guide/data_types.html.md':'user-guide/data_types.md'
190+
'user-guide/extending.html.md':'user-guide/extending.md'
191+
'user-guide/gpu.html.md':'user-guide/gpu.md'
192+
'user-guide/groups.html.md':'user-guide/groups.md'
193+
'user-guide/installation.html.md':'user-guide/installation.md'
194+
'user-guide/performance.html.md':'user-guide/performance.md'
195+
'user-guide/storage.html.md':'user-guide/storage.md'
196+
'user-guide/v3_migration.html.md':'user-guide/v3_migration.md'
197+
'developers/contributing.html.md':'contributing.md'
198+
'developers/index.html.md':'contributing.md'
199+
'developers/roadmap.html.md':'https://zarr.readthedocs.io/en/v3.0.8/developers/roadmap.html'
200+
'api/zarr/index.html.md':'api/index.md'
201+
'api/zarr/abc/index.html.md':'api/abc/buffer.md'
202+
'api/zarr/abc/buffer/index.html.md':'api/abc/buffer.md'
203+
'api/zarr/abc/codec/index.html.md':'api/abc/codec.md'
204+
'api/zarr/abc/metadata/index.html.md':'api/abc/metadata.md'
205+
'api/zarr/abc/numcodec/index.html.md':'api/abc/codec.md'
206+
'api/zarr/abc/store/index.html.md':'api/abc/store.md'
207+
'api/zarr/api/index.html.md':'api/index.md'
208+
'api/zarr/api/asynchronous/index.html.md':'api/api_async.md'
209+
'api/zarr/api/synchronous/index.html.md':'api/api_sync.md'
210+
'api/zarr/buffer/index.html.md':'api/buffer.md'
211+
'api/zarr/buffer/cpu/index.html.md':'api/buffer.md'
212+
'api/zarr/buffer/gpu/index.html.md':'api/buffer.md'
213+
'api/zarr/codecs/index.html.md':'api/codecs.md'
214+
'api/zarr/codecs/numcodecs/index.html.md':'api/codecs.md'
215+
'api/zarr/convenience/index.html.md':'api/convenience.md'
216+
'api/zarr/creation/index.html.md':'api/deprecated/creation.md'
217+
'api/zarr/dtype/index.html.md':'api/dtype.md'
218+
'api/zarr/errors/index.html.md':'api/errors.md'
219+
'api/zarr/metadata/index.html.md':'api/metadata.md'
220+
'api/zarr/metadata/migrate_v3/index.html.md':'api/metadata.md'
221+
'api/zarr/registry/index.html.md':'api/registry.md'
222+
'api/zarr/storage/index.html.md':'api/storage.md'
223+
'api/zarr/testing/index.html.md':'api/testing.md'
224+
'api/zarr/testing/buffer/index.html.md':'api/testing.md'
225+
'api/zarr/testing/conftest/index.html.md':'api/testing.md'
226+
'api/zarr/testing/stateful/index.html.md':'api/testing.md'
227+
'api/zarr/testing/store/index.html.md':'api/testing.md'
228+
'api/zarr/testing/strategies/index.html.md':'api/testing.md'
229+
'api/zarr/testing/utils/index.html.md':'api/testing.md'
230+
162231

163232
# https://github.com/developmentseed/titiler/blob/50934c929cca2fa8d3c408d239015f8da429c6a8/docs/mkdocs.yml#L115-L140
164233
markdown_extensions:

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp