Shepherd Nova

This Repo contains the documentation for the public instance of the Shepherd Testbed.

The documentation is compiled with Sphinx and uses the MyST-extension to allow embedding Markdown-files.

Get sources and dependencies

Example-workflow using git and pip.

git clone https://github.com/nes-lab/shepherd-nova
cd shepherd-nova
pip install .

Generate Docs

Sphinx is used to build the website.

sphinx-build -b html ./docs ./docs/_build/html

Viewing the document in a browser:

cd ./docs/_build/html
python -m http.server

In browser go to localhost:8000 to view the documentation.