From e6624d83b79b7a3125cf7c0527117799d2f2f7ce Mon Sep 17 00:00:00 2001 From: yuzie007 Date: Fri, 1 Nov 2019 16:01:14 +0100 Subject: [PATCH] Add the installation page --- INSTALL.rst | 31 +++++++++++++++++++++++++++++++ docsrc/conf.py | 1 + docsrc/index.rst | 14 -------------- docsrc/installation.rst | 1 + 4 files changed, 33 insertions(+), 14 deletions(-) create mode 100644 INSTALL.rst create mode 100644 docsrc/installation.rst diff --git a/INSTALL.rst b/INSTALL.rst new file mode 100644 index 0000000..0f34b88 --- /dev/null +++ b/INSTALL.rst @@ -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 `_. + +.. code-block:: + + python -m pip install -U mpltern + +Conda +===== + +Under preparation. + +Github +====== + +The development version is available from `GitHub `_. + +.. code-block:: + + git clone https://github.com/yuzie007/mpltern.git + cd mpltern + python setup.py install diff --git a/docsrc/conf.py b/docsrc/conf.py index a8d36a2..44e0124 100644 --- a/docsrc/conf.py +++ b/docsrc/conf.py @@ -131,6 +131,7 @@ def __call__(self, *args, **kwargs): html_theme_options = { 'navbar_links': [ # ("home", "index"), + ("Installation", "installation"), ("Documents", "contents"), ("Examples", "gallery/index"), ], diff --git a/docsrc/index.rst b/docsrc/index.rst index 109daf8..2362158 100644 --- a/docsrc/index.rst +++ b/docsrc/index.rst @@ -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 @@ -57,19 +56,6 @@ ternary-plot libraties: -Installation -============ - -The latest version of mpltern is available from `GitHub `_. - -.. 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 ============== diff --git a/docsrc/installation.rst b/docsrc/installation.rst new file mode 100644 index 0000000..a23a75e --- /dev/null +++ b/docsrc/installation.rst @@ -0,0 +1 @@ +.. include:: ../INSTALL.rst