Documentation Repository

Documentation: readthedocs

Useful links

• Sphinx Sphinx is a tool to compile ReStructuredText documentation into a variety of formats.
• ReStructuredText
• Getting started (readthedocs)

Build the documentation locally

Install Graphviz:

Using apt (Ubuntu / Debian):

sudo apt-get install graphviz

Using brew (Mac OS X):

sudo brew install graphviz

Install requirements:

pip install -r requirements.txt

Make sure you have the dot command from graphviz and a basic LaTeX environment in your path!

Build html:

make html

If the mico backend is running on localhost:8080 make html will automatically update the openapi.json file.

open _build/html/index.html in your browser

Enabled Extensions

• sphinx.ext.intersphinx

  List all link targets in the documentation:

  python -m sphinx.ext.intersphinx ./_build/html/objects.inv

• sphinx.ext.autosectionlabel

• sphinx.ext.todo

• sphinx.ext.imgmath

• sphinx.ext.graphviz

• sphinxcontrib.httpdomain

• sphinxcontrib.openapi

• sphinx.markdown-tables