Building these docs

  • Install dependencies from requirements.dev.txt and requirements.txt.

  • When developing, you can use sphinx-autobuild to get an development server that automatically refreshes on changes:

# Auto reload dev server:
sphinx-autobuild docs docs/_build/html
  • To make a ‘production’ build of the docs, run make html from the docs/ folder. This will generate a html based structure in docs/_build/html.

# Build docs to docs/_build/html
cd docs && make