Skip to content

Working with Docs

This project uses MkDocs to generate its documentation so first install it using conda (Miniconda or Anaconda).

conda env create -f ./environment.yml

And then activate the just created botler-mkdocs enviroment.

conda activate botler-mkdocs

From this point on you can just use the mkdocs command to serve (mkdocs serve) or build (mkdocs build) the docs. For additional information check out the MkDocs Docs or the Material Theme Docs of the theme used.


Last update: May 1, 2021