Skip to content

Commit

Permalink
Merge pull request #2 from zacharyburnett/fix/rtd
Browse files Browse the repository at this point in the history
update RTD config to use base conda environment and install from project metadata
  • Loading branch information
mfixstsci authored Feb 1, 2024
2 parents 2a7656d + f497395 commit 19654f5
Showing 2 changed files with 22 additions and 9 deletions.
22 changes: 13 additions & 9 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -9,21 +9,25 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
python: mambaforge-4.10

conda:
environment: docs/rtd_environment.yaml

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
builder: html
configuration: docs/conf.py
fail_on_warning: true

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: requirements.txt
install:
- method: pip
path: .
extra_requirements:
- docs
9 changes: 9 additions & 0 deletions docs/rtd_environment.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: rtd311
channels:
- conda-forge
- defaults
dependencies:
- python=3.11
- pip
- graphviz
- sphinx_rtd_theme>1.2.0

0 comments on commit 19654f5

Please sign in to comment.