Skip to content

Commit 6ef11d3

Browse files
authored
fix #1167: Added installation.rst to docs (#1170)
* Added installation.rst to docs * Removed _installation_ section from index.rst
1 parent 748d176 commit 6ef11d3

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

docs/index.rst

+1-32
Original file line numberDiff line numberDiff line change
@@ -25,44 +25,13 @@ Zarr is still a young project. Feedback and bug reports are very welcome, please
2525
the `GitHub issue tracker <https://github.com/zarr-developers/zarr-python/issues>`_. See
2626
:doc:`contributing` for further information about contributing to Zarr.
2727

28-
Installation
29-
------------
30-
31-
Zarr depends on NumPy. It is generally best to `install NumPy
32-
<https://numpy.org/doc/stable/user/install.html>`_ first using whatever method is most
33-
appropriate for you operating system and Python distribution. Other dependencies should be
34-
installed automatically if using one of the installation methods below.
35-
36-
Install Zarr from PyPI::
37-
38-
$ pip install zarr
39-
40-
Alternatively, install Zarr via conda::
41-
42-
$ conda install -c conda-forge zarr
43-
44-
To install the latest development version of Zarr, you can use pip with the
45-
latest GitHub main::
46-
47-
$ pip install git+https://github.com/zarr-developers/zarr-python.git
48-
49-
To work with Zarr source code in development, install from GitHub::
50-
51-
$ git clone --recursive https://github.com/zarr-developers/zarr-python.git
52-
$ cd zarr-python
53-
$ python setup.py install
54-
55-
To verify that Zarr has been fully installed, run the test suite::
56-
57-
$ pip install pytest
58-
$ python -m pytest -v --pyargs zarr
59-
6028
Contents
6129
--------
6230

6331
.. toctree::
6432
:maxdepth: 2
6533

34+
installation
6635
tutorial
6736
api
6837
spec

docs/installation.rst

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Installation
2+
============
3+
4+
Zarr depends on NumPy. It is generally best to `install NumPy
5+
<https://numpy.org/doc/stable/user/install.html>`_ first using whatever method is most
6+
appropriate for you operating system and Python distribution. Other dependencies should be
7+
installed automatically if using one of the installation methods below.
8+
9+
Install Zarr from PyPI::
10+
11+
$ pip install zarr
12+
13+
Alternatively, install Zarr via conda::
14+
15+
$ conda install -c conda-forge zarr
16+
17+
To install the latest development version of Zarr, you can use pip with the
18+
latest GitHub main::
19+
20+
$ pip install git+https://github.com/zarr-developers/zarr-python.git
21+
22+
To work with Zarr source code in development, install from GitHub::
23+
24+
$ git clone --recursive https://github.com/zarr-developers/zarr-python.git
25+
$ cd zarr-python
26+
$ python setup.py install
27+
28+
To verify that Zarr has been fully installed, run the test suite::
29+
30+
$ pip install pytest
31+
$ python -m pytest -v --pyargs zarr

0 commit comments

Comments
 (0)