shirtsgroup / physical_validation

Physical validation of molecular simulations
https://physical-validation.readthedocs.io
MIT License
55 stars 19 forks source link

Fix documentation error #184

Closed ptmerz closed 2 years ago

ptmerz commented 2 years ago

RTD documentation were failing since about two weeks, related to https://github.com/sphinx-doc/sphinx/issues/9727. RTD does by default keep sphinx at version < 2 for existing projects. Older versions of sphinx do no define their version dependency on docutils. docutils, in turn, was recently updated breaking compatibility with sphinx.

This change cleans up the dependencies of the RTD build, updating and pinning the versions of the dependencies. This should make the documentation builds stable and reproducible.

Todos

Notable points that this PR has either accomplished or will accomplish.

Status

codecov[bot] commented 2 years ago

Codecov Report

Merging #184 (8a821ca) into master (885b2c2) will not change coverage. The diff coverage is n/a.

ptmerz commented 2 years ago

Confirmed via https://physical-validation--184.org.readthedocs.build/en/184/index.html that this fixes the problem and doesn't seem to break anything.