Contributing#

We welcome any and all contributions be it through Github issues, pull requests, documentation updates or general feedback.

Contributing to the wiki#

The documentation site you're visiting is powered by Read the Docs. All information is stored in the main git repo under the docs folder. If you find a mistake or want to clarify something please feel free to open a pull request and contribute.

Local install#

1. Install Python

2. Install requirements

   pip install mkdocs
   pip install -r docs/requirements.txt
   

3. Run site locally

   mkdocs serve
   

4. Visit http://localhost:8000/ to view your local copy of the documentation site