Skip to content

Documentation

This project uses MkDocs to generate the documentation. MkDocs is a static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

This project uses the Material for MkDocs theme.

Installation

To assist in using mkdocs on any environment, mkdocs software can be installed through Micromamba python environment. To install mkdocs, run the following command:

Start the python environment by running the following command:

micromamba activate cap-video
micromamba activate cap-video

Serving the documentation locally

To serve the documentation locally, run the following command:

mkdocs serve
mkdocs serve