The documentation uses mkdocs and the markdown_inline_graphviz extension as static site generator. The documentation on docs.opencast.org is updated once a day from these sources. For details about the automated build, check out:

• https://github.com/opencast/docs.opencast.org

A quick example on how to build/serve the docs locally. Requires python virtual environment.

% cd guides
% python -m venv venv
% . ./venv/bin/activate
% pip install -r requirements.txt
% cd developer
% python -m mkdocs serve

The guides come with a few automated style checks. They are executed on pull requests automatically but you can also run them locally:

% cd guides
% npm install
% npm test