To compile and build the documentation site locally, download and install mkdocs. Instructions are here.
You will need the PymDown extensions. Install with pip install pymdown-extensions
. For more information on the PymDown extensions, go here.
Then, clone the version of the docs you are interested in, cd
to the docs
root, and run mkdocs build
, then mkdocs serve
.
If you run in --strict
mode, you will receive warnings about any broken links.
Have fun.
python3 setup.py install
python3 setup.py build_sass