From 10ee9a52001ce7a89a4a9f2de84739e71ed02b46 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Sat, 19 Sep 2020 09:56:01 +0200
Subject: [PATCH] fix(docs): Add a warning when using Sphinx 3
Hawkmoth is not yet working with Spinx 3; issue a warning when detecting
a Sphinx 3 environment as the resulting docs will be broken.
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/conf.py | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/conf.py b/Documentation/conf.py
index b80d8dadd..a471a3259 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -15,6 +15,14 @@ sys.path.insert(0, os.path.abspath("./"))
logger = sphinx.util.logging.getLogger("card10/conf.py")
+# Hawkmoth does not yet support Sphinx 3
+#
+# See https://github.com/jnikula/hawkmoth/issues/17
+if sphinx.version_info[0] > 2:
+ logger.warning(
+ "Sphinx versions >= 3 are not yet working properly with hawkmoth. Documentation of C items will probably be broken ..."
+ )
+
# -- Project information -----------------------------------------------------
--
GitLab