-
To display Jupyter Notebooks in the manual, the nbsphinx package is used. This package requires pandoc to be installed on the system.
-
This repository includes a Git submodule. The submodule is the training-resources folder. Important to note that when this repository is normally cloned with
git clone <url>
, thetraining-resources
folder is not populated with files. To clone this project and populate thetraining-resources
folder usegit clone --recursive <url>
. Furthermore, to pull the latest changes for the submodule rungit submodule update --remote
.
To build the documentation website run make html
which will generate a _build folder. The generated folder will contain a html folder that includes all the assets for hosting the documentation.