Jon Daniels 319222f3b9
Update index.md (#249)
changing from "be" to "by"
2021-06-22 17:23:22 -07:00
..
2021-06-22 17:23:22 -07:00
2018-11-29 13:08:46 -07:00
2016-04-23 12:19:28 -04:00

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.