Build documentation with MkDocs
For the space rover game, we used MkDocs to create our documentation.
Commands
Execute the following commands in powershell.
cd docs
python -m venv venv
venv\Scripts\activate
python -m pip install mkdocs
python -m pip install "mkdocstrings[python]"
python -m pip install mkdocs-material
mkdocs new .
mkdocs serve
For a full tutorial see python-project-documentation-with-mkdocs.
Publish mkdocs to github pages
Execute this command locally on your branch you want to publish: mkdocs gh-deploy
.
Full documentation here Deploy mkdocs to GitHub Pages.
Cinder Theme
cinder is a theme we used to build our documentation.