Skip to content

Commit

Permalink
Fix documentation error
Browse files Browse the repository at this point in the history
RTD documentation were failing since about two weeks, related to
sphinx-doc/sphinx#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.
  • Loading branch information
ptmerz committed Nov 4, 2021
1 parent 885b2c2 commit 8a821ca
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
7 changes: 7 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py
Expand All @@ -17,4 +23,5 @@ formats:
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: requirements.txt
- requirements: doc/requirements.txt
8 changes: 3 additions & 5 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
numpy
scipy
matplotlib
pymbar
nbsphinx
sphinx==4.2.0
nbsphinx==0.8.7
sphinx_rtd_theme==1.0.0

0 comments on commit 8a821ca

Please sign in to comment.