Skip to content

Development notes for documentation

Marina Evers edited this page Sep 5, 2024 · 1 revision

Compile the documentation locally

While the documentation is automatically built when updating the main branch, it is often helpful to build it locally (to check the layout, etc.). You can follow the following steps:

  • Change to the docs directory
  • Install sphinx if necessary (pip install -U sphinx and pip install -r requirements.txt)
  • Build the website using make html
  • Open the local version of the website which you can find in the path that is printed by the build process
Clone this wiki locally