Skip to content

Documentation

Building documentation requires Python 3.6+.

Install Dependencies

Install mkdocs, themes, and extensions.

1
pip install -r docs/requirements_docs.txt

Serving

To serve the documentation locally run

1
mkdocs serve

and visit the docs at http://127.0.0.1:8000/wrappers/

Deploying

If you have write access to the repo, docs can be updated using

1
mkdocs gh-deploy