Skip to contentSkip to conversation

docs: Note that sphinx 1.7 will be required soon

RFC PATCH New Jonathan Corbet 1 participant 1 message Nov 30, 2020 Documentation

lore
Share & tools
lore

Jonathan Corbet

author maintainer
#0 lore raw

RFC PATCH 1/1 docs: Note that sphinx 1.7 will be required soon

The time has come to drop support for some truly ancient versions of sphinx; put in a warning now.

---
This is pretty conservative; I think we could make an honest case for pushing things forward to 2.4 but ... one step at a time...

I'd also like to think about dropping Python 2, but that's a separate subject.

 Documentation/conf.py | 3 +++
 1 file changed, 3 insertions(+)
Documentation/conf.py +3 -0
index ed2b43ec7754..d76270cfa37f 100644
@@ -112,6 +112,9 @@ if major >= 3:
 
 else:
     extensions.append('cdomain')
+    if major == 1 and minor < 7:
+        sys.stderr.write('WARNING: Sphinx 1.7 or greater will be required as of '
+                         'the 5.12 release\n')
 
 # Ensure that autosectionlabel will produce unique names
 autosectionlabel_prefix_document = True
Signature · 1 line
2.28.0