Skip to content

Commit

Permalink
Fix for ReadtheDocs build (#1061)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
ericwb authored Sep 21, 2023
1 parent f016e50 commit 02faada
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.8"

sphinx:
configuration: doc/source/conf.py

python:
install:
- requirements: requirements.txt
- requirements: doc/requirements.txt

0 comments on commit 02faada

Please sign in to comment.