The project is using mkdocs to generate documentation from markdown files.
-
Clone the repo to your Codio python based box or locally
-
install
mkdocs
https://www.mkdocs.org/#installationpip install -r requirements.txt
- start development mode with
mkdocs serve -a 0.0.0.0:8000
command (If using Codio set up in .codio file - Start mkdocs) - Edit files and preview in your browser on port 8000 (If using Codio set up in .codio file - Preview)
Merge to master branch deploys the changes using Github actions.