Skip to content

Commit

Permalink
DOC: Move install info to installation.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
has2k1 committed Apr 22, 2017
1 parent 6995cdf commit 81857c6
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 46 deletions.
52 changes: 6 additions & 46 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,65 +1,25 @@
.. _index:

Mizani documentation
====================

Mizani is Python package that provides the pieces necessary to create scales for a graphics system. It is based on Hadley Wickham's `Scales`_ package.


Installation
------------

Mizani can be installed in a handful of ways.

1. Official release *(Recommended)*

.. code-block:: console
$ pip install mizani
If you don't have `pip`_ installed, this `Python installation guide`_
can guide you through the process.


2. Development sources

.. code-block:: console
$ pip install git+https://github.com/has2k1/mizani.git
Or

.. code-block:: console
$ git clone https://github.com/has2k1/mizani.git
$ cd mizani
$ python setup.py install
Or

.. code-block:: console
$ curl -OL https://github.com/has2k1/mizani/archive/master.zip
$ unzip master
$ cd mizani-master
$ python setup.py install
Mizani
======

Mizani is python library that provides the pieces necessary to create scales
for a graphics system. It is based on the R `Scales`_ package.

Contents
--------

.. toctree::
:maxdepth: 2
:maxdepth: 1

bounds
breaks
formatters
palettes
transforms
scale
installation
changelog


.. _Scales: https://github.com/hadley/scales
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
35 changes: 35 additions & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Installation
============

mizani can be can be installed in a couple of ways depending on purpose.

Official release installation
-----------------------------
For a normal user, it is recommended to install the official release.

.. code-block:: console
$ pip install mizani
Development installation
------------------------
To do any development you have to clone the
`mizani source repository`_ and install
the package in development mode. These commands do all of that:

.. code-block:: console
$ git clone https://github.com/has2k1/mizani.git
$ cd mizani
$ pip install -e .
If you only want to use the latest development sources and do not
care about having a cloned repository, e.g. if a bug you care about
has been fixed but an official release has not come out yet, then
use this command:

.. code-block:: console
$ pip install git+https://github.com/has2k1/mizani.git
.. _mizani source repository: https://github.com/has2k1/mizani

0 comments on commit 81857c6

Please sign in to comment.