Documentation

We use the reStructuredText markup language and the Sphinx to generate the documentation.

Installing Sphinx and extensions

Sphinx

Installation:

$ pip install sphinx_rtd_theme --user

Extensions

• nbsphinx : Jupyter Notebook Tools for Sphinx:

  $ pip install nbsphinx --user
  

• sphinx-panels : creating panels in a grid layout or as drop-downs:

  $ pip install sphinx-panels --user
  

Pandoc

Installation (Ubuntu):

$ sudo apt install pandoc