Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
img
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

GitHub contributors GitHub Pipenv locked Python version Docs sanity checks and tests

Instructions for building the documentation locally

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.

You can’t perform that action at this time.