Merge pull request #7 from Fanchengyan/dev

add conda in docs

.github/workflows/tests.yml

@@ -1,5 +1,5 @@
 
-name: Tests
+name: tests
 
 on:
    pull_request:

README.md

@@ -2,10 +2,17 @@
 <img src="https://raw.githubusercontent.com/Fanchengyan/myst-sphinx-gallery/main/docs/source/_static/logo/logo.svg" width="400">
 </h1><br>
 
-[![PyPI](https://img.shields.io/pypi/v/myst-sphinx-gallery)](https://pypi.org/project/myst-sphinx-gallery/)
+
+[![Conda Recipe](https://img.shields.io/badge/recipe-myst--sphinx--gallery-green.svg)](https://anaconda.org/conda-forge/myst-sphinx-gallery)
 [![Documentation Status](https://readthedocs.org/projects/myst-sphinx-gallery/badge/?version=latest)](https://myst-sphinx-gallery.readthedocs.io/en/latest/?badge=latest)
+[![Language](https://img.shields.io/badge/python-3.8%2B-blue.svg?style=flat-square)](https://www.python.org/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/myst-sphinx-gallery.svg)](https://anaconda.org/conda-forge/myst-sphinx-gallery)
+[![PyPI](https://img.shields.io/pypi/v/myst-sphinx-gallery)](https://pypi.org/project/myst-sphinx-gallery/)
+[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/myst-sphinx-gallery.svg)](https://anaconda.org/conda-forge/myst-sphinx-gallery)
+[![tests](https://github.com/Fanchengyan/myst-sphinx-gallery/actions/workflows/tests.yml/badge.svg)](https://github.com/Fanchengyan/myst-sphinx-gallery/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/gh/Fanchengyan/myst-sphinx-gallery/graph/badge.svg?token=IHXYE1K1G9)](https://codecov.io/gh/Fanchengyan/myst-sphinx-gallery)
 
+
 ## Introduction
 
 **MyST Sphinx Gallery** is a Sphinx extension that allows you to build galleries of examples from Jupyter Notebooks (`.ipynb`), Markdown (`.md`) or reStructuredText (`.rst`) files.  It works with `MyST` Ecosystem, including [MyST-parser](https://myst-parser.readthedocs.io/en/latest/) and [MyST-NB](https://myst-nb.readthedocs.io/en/latest/), to render markdown or jupyter notebooks in Sphinx documentation.
@@ -37,6 +44,16 @@ The detailed documentation is available at: [https://myst-sphinx-gallery.readthe
 pip install myst_sphinx_gallery
 ```
 
+or using `conda` / `mamba` from the conda-forge channel:
+
+```bash
+conda install -c conda-forge myst-sphinx-gallery
+```
+
+```bash
+mamba install -c conda-forge myst-sphinx-gallery
+```
+
 ## Configure and usages
 
 To use MyST Sphinx Gallery, you need to add the following code to the Sphinx `conf.py` file:

docs/source/index.rst

@@ -2,17 +2,28 @@
 MyST Sphinx Gallery
 ===================
 
-.. image:: https://img.shields.io/pypi/v/myst-sphinx-gallery
-   :target: https://pypi.org/project/myst-sphinx-gallery/
-   :alt: PyPI
+.. image:: https://img.shields.io/badge/recipe-myst--sphinx--gallery-green.svg
+   :target: https://anaconda.org/conda-forge/myst-sphinx-gallery
+
 
 .. image:: https://readthedocs.org/projects/myst-sphinx-gallery/badge/?version=latest
    :target: https://myst-sphinx-gallery.readthedocs.io/en/latest/?badge=latest
-   :alt: Documentation Status
+
+.. image:: https://img.shields.io/conda/vn/conda-forge/myst-sphinx-gallery.svg
+   :target: https://anaconda.org/conda-forge/myst-sphinx-gallery
+
+.. image:: https://img.shields.io/pypi/v/myst-sphinx-gallery
+   :target: https://pypi.org/project/myst-sphinx-gallery/
+
+.. image:: https://img.shields.io/conda/dn/conda-forge/myst-sphinx-gallery.svg
+   :target: https://anaconda.org/conda-forge/myst-sphinx-gallery
+
+.. image:: https://github.com/Fanchengyan/myst-sphinx-gallery/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/Fanchengyan/myst-sphinx-gallery/actions/workflows/tests.yml
 
 .. image:: https://codecov.io/gh/Fanchengyan/myst-sphinx-gallery/graph/badge.svg?token=IHXYE1K1G9
    :target: https://codecov.io/gh/Fanchengyan/myst-sphinx-gallery
-   :alt: Code Coverage
+
 
 Introduction
 ------------

docs/source/user_guide/quick_start.rst

@@ -9,12 +9,23 @@ This page gives a quick start guide of how to get started with MyST Sphinx Galle
 Installation
 ------------
 
-You can install MyST Sphinx Gallery using pip:
+**MyST Sphinx Gallery** is a Python package, and requires Python >= 3.8. You can install the latest release using pip from the PyPI:
 
 .. code-block:: bash
 
    pip install myst-sphinx-gallery
 
+or using ``conda`` / ``mamba``:
+
+.. code-block:: bash
+
+   conda install -c conda-forge myst-sphinx-gallery
+
+.. code-block:: bash
+
+   mamba install -c conda-forge myst-sphinx-gallery
+
+
 Configure and usages
 --------------------