[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH] docs: Print warning when running Sphinx 3.x and newer
From: |
Eduardo Habkost |
Subject: |
[PATCH] docs: Print warning when running Sphinx 3.x and newer |
Date: |
Wed, 14 Oct 2020 18:33:56 -0400 |
This won't prevent the docs from being built, but will let people
know Sphinx 3.x is not fully supported yet.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
docs/conf.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index 00e1b750e2..1d92e65d12 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -40,6 +40,11 @@ if sys.version_info < (3,6):
raise ConfigError(
"QEMU requires a Sphinx that uses Python 3.6 or better\n")
+# Sphinx 3.x may be able to build the documents, but it may generate
+# warnings and/or the document may be formatted incorrectly
+if sphinx.version_info >= (3, 0):
+ sys.stderr.write('WARNING: Sphinx 3.x is not fully supported by QEMU\n')
+
# The per-manual conf.py will set qemu_docdir for a single-manual build;
# otherwise set it here if this is an entire-manual-set build.
# This is always the absolute path of the docs/ directory in the source tree.
--
2.28.0
- [PATCH] docs: Print warning when running Sphinx 3.x and newer,
Eduardo Habkost <=