Add github action to see if the docs build without errors#13
Add github action to see if the docs build without errors#13phackstock wants to merge 3 commits into
Conversation
znicholls
left a comment
There was a problem hiding this comment.
Do we want to (either here or make a new issue) add:
- stricter check that there's no warning on build (e.g.
sphinx-build -M html docs/source docs/build -qW) - check that all the modules that should be covered are indeed covered when building the docs (somehow with
sphinx-build -M html docs/source docs/build -Eqn -b coverageand some other stuff I think this can be made to work well)
|
@znicholls I took a quick look at both your suggestions and they both look really good to me. |
|
Nice pickup. I've always used |
|
Hey, would indeed be nice I think to remove the warning, but keep the instructions on GitHub. If that can work, i don't really mind where that file would rest, so I'd vote for doing the easiest way there - can be done within this PR as |
Closes #12.
Adding a GitHub action to verify that the docs can be built without any errors. Runs on every PR and on pushes on
main.Tests addedDocumentation addedExample added (in the documentation, to an existing notebook, or in a new notebook)CHANGELOG.rstadded (single line such as:(`#XX <https://github.com/iiasa/climate-assessment/pull/XX>`_) Added feature which does something)