Skip to content

Fix readthedocs to use pip-based install #817

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Dec 18, 2022
Merged

Fix readthedocs to use pip-based install #817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02c39ca
update readthedocs build process
murrayrm Dec 18, 2022
b7f394c
pin docutils to 0.16 until sphinx_rtd_theme is fixed
murrayrm Dec 18, 2022
7278651
use ubuntu-22.04
murrayrm Dec 18, 2022
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
21 changes: 21 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

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

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: doc/requirements.txt
1 change: 1 addition & 0 deletions doc-requirements.txt → doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ sphinx_rtd_theme
numpydoc
ipykernel
nbsphinx
docutils==0.16 # pin until sphinx_rtd_theme is compatible with 0.17 or later