#!/usr/bin/env python # coding: utf-8 # This notebook is part of the `nbsphinx` documentation: https://nbsphinx.readthedocs.io/. # # Installation # # Note that some packages may be out of date. # You can always get the newest `nbsphinx` release from [PyPI](https://pypi.org/project/nbsphinx) (using `pip`). # If you want to try the latest development version, have a look at the section [Contributing](contributing.rst). # # ## `nbsphinx` Packages # # [![Anaconda Badge](https://anaconda.org/conda-forge/nbsphinx/badges/version.svg)](https://anaconda.org/conda-forge/nbsphinx) # # If you are using the `conda` package manager (e.g. with [Anaconda](https://www.anaconda.com/products/individual#Downloads) for Linux/macOS/Windows), you can install `nbsphinx` from the [conda-forge](https://conda-forge.org/) channel: # # conda install -c conda-forge nbsphinx # # [![PyPI version](https://badge.fury.io/py/nbsphinx.png)](https://pypi.org/project/nbsphinx) # # You can of course also install `nbsphinx` with `pip`, Python's own package manager: # # python3 -m pip install nbsphinx # # Depending on your Python installation, # you may have to use `python` instead of `python3`. # If you have installed the module already, # you can use the `--upgrade` flag to get the newest release. # # [venv]: https://docs.python.org/3/tutorial/venv.html # ## `nbsphinx` Prerequisites # # Some of the aforementioned packages will install some of these prerequisites automatically, some of the things may be already installed on your computer anyway. # # ### Python # # Of course you'll need Python, because both Sphinx and `nbsphinx` are implemented in Python. # There are many ways to get Python. # If you don't know which one is best for you, you can try [Anaconda](https://www.anaconda.com/products/individual#Downloads). # # ### Sphinx # # You'll need [Sphinx](https://www.sphinx-doc.org/) as well, because `nbsphinx` is just a Sphinx extension and doesn't do anything on its own. # # If you use `conda`, you can get [Sphinx from the conda-forge channel](https://anaconda.org/conda-forge/sphinx): # # conda install -c conda-forge sphinx # # Alternatively, you can install it with `pip` (see below): # # python3 -m pip install Sphinx # # ### pip # # Recent versions of Python already come with `pip` pre-installed. # If you don't have it, you can [install it manually](https://pip.pypa.io/en/latest/installing/). # # ### pandoc # # The stand-alone program [pandoc](https://pandoc.org/) is used to convert Markdown content to something Sphinx can understand. You have to install this program separately, ideally with your package manager. If you are using `conda`, you can install [pandoc from the conda-forge channel](https://anaconda.org/conda-forge/pandoc): # # conda install -c conda-forge pandoc # # If that doesn't work out for you, have a look at `pandoc`'s [installation instructions](https://pandoc.org/installing.html). # #