Build docs locally

1. Get a local copy of the code repository: either clone it or download and extract ZIP of latest

2. Install the docs dependencies, which are in docs/requirements.txt [pip3 install -r docs/requirements.txt]

3. cd into the docs folder

4. Run make html, or on Windows ./make.bat html

5. If build succeeds, open build/html/index.html in your browser

Between builds you may sometimes have to make clean for things to work properly, for example when updating public files like images or css.

There are a few things that don’t seem to work locally, that do work on readthedocs:

• No twisties to open subsections in the sidebar

• When you navigate to another section or subsection, the sidebar does not automatically scroll to where you were