docs: update 2020-08 -- LinuxDoc not supports Sphinx v3.0 or above

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
return42 · Aug 13, 2020 · fad45af · fad45af
1 parent cea5223
commit fad45af
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,6 +7,15 @@
 LinuxDoc
 ========
 
+.. sidebar::  update 2020-08
+
+   ATM LinuxDoc does not support Sphinx v3.0 or above (:commit:`a5290d5`).  The
+   v3.0 includes a `C, initial rewrite`_ which is not downward compatible.  The
+   :py:mod:`linuxdoc.cdomain` needs a complete revision within the model used by
+   Sphinx v3.
+
+.. _C, initial rewrite:   https://github.com/sphinx-doc/sphinx/commit/0f49e30c51b5cc5055cda5b4b294c2dd9d1df573#r38750737
+
 The LinuxDoc library contains sphinx-doc_ extensions and command line tools to
 extract documentation from C/C++ source file comments. Even if this project
 started in context of the Linux-Kernel documentation (where the name comes