From 1546e1ac45c7ef5ac74646b1af8aefe1327fd19b Mon Sep 17 00:00:00 2001
From: Sebastien Roy <sebastien.roy@qognitive.io>
Date: Thu, 3 Oct 2024 16:59:10 -0400
Subject: [PATCH] document why warnings on RTD must be disabled

---
 .readthedocs.yaml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index b6d16f0..d190340 100644
--- 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: