Building documentation locally

To build documentation, go into project’s doc folder.

$ cd doc  # assuming that you start from the project's root.

Make sure you have installed into your virtual environment libraries from docs extras: pip install neurom[docs]. Then run the command in the doc folder:

$ make html

This builds the documentation in doc/build. To view it, open doc/build/html/index.html in a browser.