Skip to content

Commit 02faada

Browse files
authored
Fix for ReadtheDocs build (#1061)
The ReadtheDocs build is currently failing because it is unable to find sphinx_copybutton. This occurs because ReadtheDocs by default will only install dependencies of the default requirements.txt at the root. The fix needs to install the sphinx_copybutton package found in doc/requirements.txt. ReadtheDocsv2 now provides a better configuration using a YAML file [1] instead of just the UI and its limited options. This change adds the new .readthedocs.yaml file that allows us to control what dependencies are installed via two requirements.txt files, one in root and one in doc/. [1] https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os Signed-off-by: Eric Brown <[email protected]>
1 parent f016e50 commit 02faada

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

.readthedocs.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.8"
7+
8+
sphinx:
9+
configuration: doc/source/conf.py
10+
11+
python:
12+
install:
13+
- requirements: requirements.txt
14+
- requirements: doc/requirements.txt

0 commit comments

Comments
 (0)