Skip to content

Commit e27bdf8

Browse files
alimanfooalimanfoo
authored
Merge pull request zarr-developers#185 from alimanfoo/2.2-docs
Documentation for 2.2 release
2 parents 0a0fb1a + 5b7bdb9 commit e27bdf8

24 files changed

Lines changed: 1347 additions & 779 deletions

‎.gitignore‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,13 @@ target/
6565
# setuptools-scm
6666
zarr/version.py
6767

68-
# test data
69-
*.zarr
68+
# emacs
7069
*~
71-
*.zip
72-
example*
73-
doesnotexist
74-
test_sync*
70+
71+
# test data
72+
#*.zarr
73+
#*.zip
74+
#example*
75+
#doesnotexist
76+
#test_sync*
77+
data/*

‎data/donotdelete‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This directory is used for data files created during testing.

‎docs/api/convenience.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Array creation (``zarr.convenience``)
2-
=====================================
1+
Convenience functions (``zarr.convenience``)
2+
============================================
33
.. automodule:: zarr.convenience
44
.. autofunction:: open
55
.. autofunction:: save

‎docs/api/storage.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@ Storage (``zarr.storage``)
22
==========================
33
.. automodule:: zarr.storage
44

5-
.. autofunction:: init_array
6-
.. autofunction:: init_group
7-
85
.. autoclass:: DictStore
96
.. autoclass:: DirectoryStore
107
.. autoclass:: TempStore
118
.. autoclass:: NestedDirectoryStore
129
.. autoclass:: ZipStore
13-
.. autoclass:: DBMStore
1410

1511
.. automethod:: close
1612
.. automethod:: flush
1713

14+
.. autoclass:: DBMStore
15+
16+
.. automethod:: close
17+
.. automethod:: sync
18+
19+
.. autofunction:: init_array
20+
.. autofunction:: init_group
1821
.. autofunction:: migrate_1to2

‎docs/conf.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def __getattr__(cls, name):
3434

3535

3636
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
37-
37+
3838

3939
# If extensions (or modules to document with autodoc) are in another directory,
4040
# add these directories to sys.path here. If the directory is relative to the
@@ -55,10 +55,12 @@ def __getattr__(cls, name):
5555
'sphinx.ext.autosummary',
5656
'sphinx.ext.viewcode',
5757
'numpydoc',
58+
'sphinx_issues',
5859
]
5960

6061
numpydoc_show_class_members = False
6162
numpydoc_class_members_toctree = False
63+
issues_github_path = 'alimanfoo/zarr'
6264

6365
# Add any paths that contain templates here, relative to this directory.
6466
templates_path = ['_templates']

‎docs/index.rst‎

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Highlights
1212

1313
* Create N-dimensional arrays with any NumPy dtype.
1414
* Chunk arrays along any dimension.
15-
* Compress and/or filter chunks using any numcodecs_ codec.
15+
* Compress and/or filter chunks using any NumCodecs_ codec.
1616
* Store arrays in memory, on disk, inside a Zip file, on S3, ...
1717
* Read an array concurrently from multiple threads or processes.
1818
* Write to an array concurrently from multiple threads or processes.
@@ -65,15 +65,19 @@ Contents
6565
Acknowledgments
6666
---------------
6767

68-
The following people have contributed to the development of Zarr, by contributing code and/or
69-
providing ideas, feedback and advice:
68+
The following people have contributed to the development of Zarr by contributing code,
69+
documentation, code reviews, comments and/or ideas:
7070

71-
* `Francesc Alted <https://github.com/FrancescAlted>`_
72-
* `Stephan Hoyer <https://github.com/shoyer>`_
73-
* `John Kirkham <https://github.com/jakirkham>`_
74-
* `Alistair Miles <https://github.com/alimanfoo>`_
75-
* `Matthew Rocklin <https://github.com/mrocklin>`_
76-
* `Vincent Schut <https://github.com/vincentschut>`_
71+
* :user:`Francesc Alted <FrancescAlted>`
72+
* :user:`Martin Durant <martindurant>`
73+
* :user:`Stephan Hoyer <shoyer>`
74+
* :user:`John Kirkham <jakirkham>`
75+
* :user:`Alistair Miles <alimanfoo>`
76+
* :user:`Mamy Ratsimbazafy <mratsim>`
77+
* :user:`Matthew Rocklin <mrocklin>`
78+
* :user:`Vincent Schut <vincentschut>`
79+
* :user:`Anthony Scopatz <scopatz>`
80+
* :user:`Prakhar Goel <newt0311>`
7781

7882
Zarr is inspired by `HDF5 <https://www.hdfgroup.org/HDF5/>`_, `h5py
7983
<http://www.h5py.org/>`_ and `bcolz <http://bcolz.blosc.org/>`_.
@@ -88,4 +92,4 @@ Indices and tables
8892
* :ref:`modindex`
8993
* :ref:`search`
9094

91-
.. _numcodecs: http://numcodecs.readthedocs.io/
95+
.. _NumCodecs: http://numcodecs.readthedocs.io/

0 commit comments

Comments
 (0)