From 5d1209bd194eb3e35bfc19c2b14c7bab02674d01 Mon Sep 17 00:00:00 2001 From: Anderson Banihirwe Date: Thu, 18 Aug 2022 14:02:36 -0600 Subject: [PATCH] Docs improvement: use sphinx-design tabs (#504) --- docs/environment.yml | 1 + docs/source/how-to/install-intake-esm.md | 42 ++++++++++++++++-------- 2 files changed, 29 insertions(+), 14 deletions(-) diff --git a/docs/environment.yml b/docs/environment.yml index e73acec8..b9a8d4be 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -14,6 +14,7 @@ dependencies: - python=3.9 - s3fs - sphinx-copybutton + - sphinx-design - watermark - zarr - pip: diff --git a/docs/source/how-to/install-intake-esm.md b/docs/source/how-to/install-intake-esm.md index b4865b6b..4f66dd36 100644 --- a/docs/source/how-to/install-intake-esm.md +++ b/docs/source/how-to/install-intake-esm.md @@ -1,21 +1,35 @@ -# Install Intake-esm +# Install intake-ESM -Intake-esm can be installed from PyPI with pip: +intake-ESM can be installed in three ways: -```bash -$ python -m pip install intake-esm -``` +```{eval-rst} -It is also available from `conda-forge` for conda installations: +.. tab-set:: -```bash -$ conda install -c conda-forge intake-esm -``` + .. tab-item:: pip + + Using the `pip `__ package manager: + + .. code:: bash + + $ python -m pip install intake-esm + + .. tab-item:: conda + + Using the `conda `__ package manager that comes with the + Anaconda/Miniconda distribution: + + .. code:: bash + + $ conda install intake-esm --channel conda-forge + + .. tab-item:: Development version + + To install a development version from source: -To install a development version from source: + .. code:: bash -```bash -$ git clone https://github.com/intake/intake-esm -$ cd intake-esm -$ python -m pip install -e . + $ git clone https://github.com/intake/intake-esm + $ cd intake-esm + $ python -m pip install -e . ```