-
Notifications
You must be signed in to change notification settings - Fork 242
Description
Motivation or Problem
Commit 5de1dfa pinned us to version 5 of Sphinx with the note "set sphinx to older, compatible version"
That is 3 years old. It's now on Sphinx v8.
Desired Solution
It would be nice to stay compatible with updates - presuming they are improvements.
Potential Alternatives
If impossible to be compatible with newer versions, we should document (eg. here) what the incompatibilities are.
There are some reasons to pin a specific version for CI publishing, so that changes to Sphinx don't suddenly break our documentation builds. But if we put in place checks that it ran we could probably protect against this.
Or at least we could pin it to a more recent version than 5, and revisit it every so often?
Other notes
Recently a syntax error crept into the documentation and the CI passed on the pull request without catching the warning. I think the CI building documentation should probably alert us to problems.