Add comment describing importance of fail_on_warning to .readthedocs.yml

openforcefield · Nov 13, 2024 · 6c1936c · 6c1936c
1 parent a898ea6
commit 6c1936c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -10,6 +10,8 @@ build:
 
 sphinx:
   configuration: docs/conf.py
+  # Interchange's docs should not produce warnings; if they start,
+  # something is broken (most likely automatic API doc generation)
   fail_on_warning: true
 
 conda: