MkDocs

For full documentation of mkdocs use visit mkdocs.org.

Instructions

To see rendered docs on your laptop, run mkdocs serve in project root folder. The output will specify on which port of localhost the docs are rendered.

For every conceptually independent module, create (if it doesn't exist already) a new folder. In that folder, create .md files with the documentation. Try to follow this structure:

# Title

some high-level description, everything which is worth documenting

## Example Use

self-explanatory

## Source Code

This part can actually be self-populated.