update rtd configuration

weaverba137 · Jun 21, 2023 · acf25b3 · acf25b3
1 parent 2a08aa3
commit acf25b3
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -6,16 +6,25 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: "ubuntu-22.04"
   tools:
     python: "3.11"
+  jobs:
+    pre_install:
+      - git update-index --assume-unchanged docs/conf.py docs/rtd_environment.yaml
+
+conda:
+  environment: docs/rtd_environment.yaml
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
+  builder: html
   configuration: docs/conf.py
+  fail_on_warning: true
 
 # Optionally declare the Python requirements required to build your docs
 python:
+  system_packages: false
   install:
     - method: pip
       path: .

diff --git a/docs/rtd_environment.yaml b/docs/rtd_environment.yaml
@@ -0,0 +1,8 @@
+name: rtd311
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - python=3.11
+  - pip
+  - graphviz