Skip to content

Commit

Permalink
Pinning python versions and dependencies for building docs
Browse files Browse the repository at this point in the history
It turns out that we were pinned to a really old version of sphinx_rtd_theme (version 0.4.3).
This was probably causing rendering issues in the version hosted by read-the-docs (readthedocs/sphinx_rtd_theme#979)
  • Loading branch information
mabruzzo committed Jan 27, 2023
1 parent 192a2c0 commit 6150f4c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@

version: 2

build:
os: ubuntu-22.04
tools:
# the python version currently just matches the version used for building
# the docs with CircleCi
python: "3.10"


python:
install:
- requirements: doc/source/requirements.txt
Expand Down
10 changes: 10 additions & 0 deletions doc/source/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# This is a pip requirements.txt file used by Read the Docs to make sure all
# sphinx extensions have been installed.
breathe

# the following version numbers are somewhat arbitrary
# (they just happened to be the version on
sphinx==5.3.0

# it's important that sphinx_rtd_theme >= 0.5.1, otherwise Field Lists are
# rendered weirdly: https://github.com/readthedocs/sphinx_rtd_theme/issues/979
sphinx_rtd_theme==1.1.1

readthedocs-sphinx-search==0.1.2

0 comments on commit 6150f4c

Please sign in to comment.