Skip to content

Commit 01bc352

Browse files
committed
docs: split tutorial into multiple user guide sections
1 parent 1ac02ea commit 01bc352

File tree

17 files changed

+1390
-1805
lines changed

17 files changed

+1390
-1805
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ coverage.xml
5252
# Sphinx documentation
5353
docs/_build/
5454
docs/_autoapi
55+
docs/data
56+
data
5557

5658
# PyBuilder
5759
target/

data/donotdelete

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@
4848
"sphinx_copybutton",
4949
"sphinx_design",
5050
'sphinx_reredirects',
51+
"IPython.sphinxext.ipython_directive",
52+
"IPython.sphinxext.ipython_console_highlighting",
5153
]
5254

5355
issues_github_path = "zarr-developers/zarr-python"
@@ -87,7 +89,8 @@
8789
"spec/v1": 'https://zarr-specs.readthedocs.io/en/latest/v1/v1.0.html',
8890
"spec/v2": "https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html",
8991
"spec/v3": "https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html",
90-
"license": "https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt"
92+
"license": "https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt",
93+
"tutorial": "user-guide",
9194
}
9295

9396
# The language for content autogenerated by Sphinx. Refer to documentation

docs/guide/index.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/index.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Zarr-Python
99
:hidden:
1010

1111
getting_started
12-
tutorial
13-
guide/index
12+
user-guide/index
1413
api/index
1514
release
1615
contributing
@@ -52,20 +51,20 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
5251
.. grid-item-card::
5352
:img-top: _static/index_user_guide.svg
5453

55-
Tutorial
56-
^^^^^^^^
54+
Guide
55+
^^^^^
5756

58-
The tutorial provides working examples of Zarr classes and functions.
57+
The user guide provides a detailed guide for how to use Zarr-Python.
5958

6059
+++
6160

62-
.. button-ref:: tutorial
61+
.. button-ref:: user-guide
6362
:ref-type: ref
6463
:expand:
6564
:color: dark
6665
:click-parent:
6766

68-
To the Tutorial
67+
To the User Guide
6968

7069
.. grid-item-card::
7170
:img-top: _static/index_api.svg

0 commit comments

Comments
 (0)