Skip to content

Commit

Permalink
Add the installation page
Browse files Browse the repository at this point in the history
  • Loading branch information
yuzie007 committed Nov 1, 2019
1 parent 60642de commit e6624d8
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 14 deletions.
31 changes: 31 additions & 0 deletions INSTALL.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
############
Installation
############

.. _pypi: https://pypi.org/project/mpltern
.. _github: https://github.com/yuzie007/mpltern

PyPI
====

The latest released version is avaiable from `PyPI <pypi_>`_.

.. code-block::
python -m pip install -U mpltern
Conda
=====

Under preparation.

Github
======

The development version is available from `GitHub <github_>`_.

.. code-block::
git clone https://github.com/yuzie007/mpltern.git
cd mpltern
python setup.py install
1 change: 1 addition & 0 deletions docsrc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ def __call__(self, *args, **kwargs):
html_theme_options = {
'navbar_links': [
# ("home", "index"),
("Installation", "installation"),
("Documents", "contents"),
("Examples", "gallery/index"),
],
Expand Down
14 changes: 0 additions & 14 deletions docsrc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

.. title:: mpltern

.. _source code: https://github.com/yuzie007/mpltern
.. _Matplotlib: https://matplotlib.org
.. _seaborn: https://seaborn.pydata.org
.. _Jupyter: http://jupyter.org
Expand Down Expand Up @@ -57,19 +56,6 @@ ternary-plot libraties:
</div>
<span class="clear_screenshots"></span>

Installation
============

The latest version of mpltern is available from `GitHub <source code_>`_.

.. code-block::
git clone https://github.com/yuzie007/mpltern.git
cd mpltern
python setup.py install
Installations via PyPI and Conda are also planned.

Citing mpltern
==============

Expand Down
1 change: 1 addition & 0 deletions docsrc/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../INSTALL.rst

0 comments on commit e6624d8

Please sign in to comment.