Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix for ReadtheDocs build #1061

Merged
merged 2 commits into from
Sep 21, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fix for ReadtheDocs build
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 <eric_wade_brown@yahoo.com>
  • Loading branch information
ericwb committed Sep 20, 2023
commit 9bd0736846ae6151215b7071cb5bad60b33c4357
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