Documentation folder

August 21, 2020 ยท View on GitHub

The document uses .rst format which stands for reStructuredText (reST)](https://docutils.sourceforge.io/docs/user/rst/quickstart.html).

Cheat sheet for reST.

Initial setup

# Install python libraries
pip install --upgrade -r docs/requirements.txt

# Install pandoc, see also https://pandoc.org/installing.html
sudo apt install pandoc

Building

cd docs
make clean
PYTHONPATH=$PYTHONPATH:.. make html

Contents

  1. 1Initial setup
  2. 2Building