document why warnings on RTD must be disabled

qognitive · Oct 3, 2024 · 1546e1a · 1546e1a
1 parent 6dd6586
commit 1546e1a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -23,6 +23,8 @@ build:
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/conf.py
+  # fail on warning is disabled because sphinx does not support "requires" from cpp20 see: https://github.com/sphinx-doc/sphinx/issues/7296
+  # we should reenable when/if sphinx fixes that
   # fail_on_warning: true
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: