You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
489 B
489 B
Generating the docs
Install requirements:
pip install -r requirements.txt
Change directories into the docs folder:
cd docs
Use mkdocs structure to update the documentation. Test locally with:
mkdocs serve
Once the docs look good, publish to gh-pages branch with:
mkdocs gh-deploy --clean
** Note **: Never edit the generated site by hand because using gh-deploy blows away the gh-pages branch and you'll lose your edits.