Building documentation locally

documentation
1

you can build the docs locally

  • make docs for everything
  • make docs-fast for everything minus the api section (this is significantly faster)
  • make clean-docs to clear the built documentation, useful for caching issues (somewhat common with sphinx, our docs engine), or after switching branches
1 Like
2

once built, make docs will build incrementally, as long as there are no errors. if an error is encountered, the next run will be from scratch (which makes sense, it’s just a bit annoying)

1 Like