This is our lab website, built with Sphinx! Based on Chris Holdgraf's
- Use a codespace
- when it fully loads look for
Code Tours
in the bottom left and choose the one that matches your needs - commit to a branch and make a pull request.
The easiest way to build the website is to use nox
, which handles all of the environment generation automatically.
To do so, follow these steps:
-
Install
nox
.pip install -U nox
-
Run
tox
nox -s docs
this should install a Sphinx environment and build the site, putting the output files in _build/html
.
To run a live webserver that will auto-build and reload when you make changes, run:
nox -s docs-live