Merge pull request #185 from alimanfoo/2.2-docs

Documentation for 2.2 release

Author: alimanfoo

.gitignore

@@ -65,10 +65,13 @@ target/
 # setuptools-scm
 zarr/version.py
 
-# test data
-*.zarr
+# emacs
 *~
-*.zip
-example*
-doesnotexist
-test_sync*
+
+# test data
+#*.zarr
+#*.zip
+#example*
+#doesnotexist
+#test_sync*
+data/*

data/donotdelete

@@ -0,0 +1 @@
+This directory is used for data files created during testing.

docs/api/convenience.rst

@@ -1,5 +1,5 @@
-Array creation (``zarr.convenience``)
-=====================================
+Convenience functions (``zarr.convenience``)
+============================================
 .. automodule:: zarr.convenience
 .. autofunction:: open
 .. autofunction:: save

docs/api/storage.rst

@@ -2,17 +2,20 @@ Storage (``zarr.storage``)
 ==========================
 .. automodule:: zarr.storage
 
-.. autofunction:: init_array
-.. autofunction:: init_group
-
 .. autoclass:: DictStore
 .. autoclass:: DirectoryStore
 .. autoclass:: TempStore
 .. autoclass:: NestedDirectoryStore
 .. autoclass:: ZipStore
-.. autoclass:: DBMStore
 
     .. automethod:: close
     .. automethod:: flush
 
+.. autoclass:: DBMStore
+
+    .. automethod:: close
+    .. automethod:: sync
+
+.. autofunction:: init_array
+.. autofunction:: init_group
 .. autofunction:: migrate_1to2

docs/conf.py

@@ -34,7 +34,7 @@ def __getattr__(cls, name):
 
 
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
-                        
+
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -55,10 +55,12 @@ def __getattr__(cls, name):
     'sphinx.ext.autosummary',
     'sphinx.ext.viewcode',
     'numpydoc',
+    'sphinx_issues',
 ]
 
 numpydoc_show_class_members = False
 numpydoc_class_members_toctree = False
+issues_github_path = 'alimanfoo/zarr'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/index.rst

@@ -12,7 +12,7 @@ Highlights
 
 * Create N-dimensional arrays with any NumPy dtype.
 * Chunk arrays along any dimension.
-* Compress and/or filter chunks using any numcodecs_ codec.
+* Compress and/or filter chunks using any NumCodecs_ codec.
 * Store arrays in memory, on disk, inside a Zip file, on S3, ...
 * Read an array concurrently from multiple threads or processes.
 * Write to an array concurrently from multiple threads or processes.
@@ -65,15 +65,19 @@ Contents
 Acknowledgments
 ---------------
 
-The following people have contributed to the development of Zarr, by contributing code and/or
-providing ideas, feedback and advice:
+The following people have contributed to the development of Zarr by contributing code,
+documentation, code reviews, comments and/or ideas:
 
-* `Francesc Alted <https://github.com/FrancescAlted>`_
-* `Stephan Hoyer <https://github.com/shoyer>`_
-* `John Kirkham <https://github.com/jakirkham>`_
-* `Alistair Miles <https://github.com/alimanfoo>`_
-* `Matthew Rocklin <https://github.com/mrocklin>`_
-* `Vincent Schut <https://github.com/vincentschut>`_
+* :user:`Francesc Alted <FrancescAlted>`
+* :user:`Martin Durant <martindurant>`
+* :user:`Stephan Hoyer <shoyer>`
+* :user:`John Kirkham <jakirkham>`
+* :user:`Alistair Miles <alimanfoo>`
+* :user:`Mamy Ratsimbazafy <mratsim>`
+* :user:`Matthew Rocklin <mrocklin>`
+* :user:`Vincent Schut <vincentschut>`
+* :user:`Anthony Scopatz <scopatz>`
+* :user:`Prakhar Goel <newt0311>`
 
 Zarr is inspired by `HDF5 <https://www.hdfgroup.org/HDF5/>`_, `h5py
 <http://www.h5py.org/>`_ and `bcolz <http://bcolz.blosc.org/>`_.
@@ -88,4 +92,4 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-.. _numcodecs: http://numcodecs.readthedocs.io/
+.. _NumCodecs: http://numcodecs.readthedocs.io/