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

Modernize RTD config #999

Merged
merged 10 commits into from
Feb 28, 2022
21 changes: 14 additions & 7 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# Configuration on how ReadTheDocs (RTD) builds our documentation
# ref: https://readthedocs.org/projects/2i2c-pilot-hubs/
choldgraf marked this conversation as resolved.
Show resolved Hide resolved
# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
#
version: 2

conda:
environment: docs/environment.yml

build:
image: latest
os: ubuntu-20.04
tools:
# NOTE: This must be miniconda or it will mistakenly try to invoke `python` to do a conda install
# ref: https://stackoverflow.com/questions/69774313/why-does-rtd-run-python-env-create-instead-of-conda-env-create-when-building
python: "miniconda3-4.7"

python:
version: 3.8
install: []
sphinx:
configuration: docs/conf.py

conda:
environment: docs/environment.yml