Fix docs build and add it to CI workflow

SNEWS2 / snewpy

A Python package for working with supernova neutrinos

https://snewpy.readthedocs.io

BSD 3-Clause "New" or "Revised" License

26 stars 19 forks source link

Fix docs build and add it to CI workflow #328

Closed JostMigenda closed 5 months ago

JostMigenda commented 5 months ago

Fixes #327.

In addition to fixing the warning itself, this includes measures to more quickly discover similar issues in the future: This PR now treats warnings as errors in our docs Makefile, consistent with ReadTheDocs’ configuration. It also builds docs as part of our CI workflows, so we notice future issues on every PR and can fix them before merging broken docs into main.