docs: Raise the minimum Sphinx requirement to 2.4.4

Commit 31abfdda6527 (docs: Deprecate use of Sphinx < 2.4.x) in 6.2 added a warning that support for older versions of Sphinx would be going away. There have been no complaints, so the time has come. Raise the minimum Sphinx version to 2.4.4 and clean out some compatibility code that we no longer need.

Jonathan Corbet committed 2 years ago

Commit 3e893e11 parent 50709577 files · +7 −29Browse files

Unified · Split

7 files

Documentation/conf.py +1 −1
Documentation/doc-guide/sphinx.rst +1 −1
Documentation/process/changes.rst +1 −1
Documentation/sphinx/automarkup.py +1 −5
Documentation/sphinx/cdomain.py +1 −5
Documentation/sphinx/kfigure.py +1 −7
scripts/sphinx-pre-install +1 −9

Documentation/conf.py+1−1

@@ -47,7 +47,7 @@ from load_config import loadConfig · 46 unmodified lines
47	# -- General configuration ------------------------------------------------	47	# -- General configuration ------------------------------------------------
48		48
49	# If your documentation needs a minimal Sphinx version, state it here.	49	# If your documentation needs a minimal Sphinx version, state it here.
50	needs_sphinx = '1.7'	50	needs_sphinx = '2.4.4'
51		51
52	# Add any Sphinx extension module names here, as strings. They can be	52	# Add any Sphinx extension module names here, as strings. They can be
53	# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom	53	# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

Documentation/doc-guide/sphinx.rst+1−1

@@ -28,7 +28,7 @@ Sphinx Install · 27 unmodified lines
28	==============	28	==============
29		29
30	The ReST markups currently used by the Documentation/ files are meant to be	30	The ReST markups currently used by the Documentation/ files are meant to be
31	built with ``Sphinx`` version 1.7 or higher.	31	built with ``Sphinx`` version 2.4.4 or higher.
32		32
33	There's a script that checks for the Sphinx requirements. Please see	33	There's a script that checks for the Sphinx requirements. Please see
34	:ref:`sphinx-pre-install` for further details.	34	:ref:`sphinx-pre-install` for further details.

Documentation/process/changes.rst+1−1

@@ -58,7 +58,7 @@ mcelog 0.6 mcelog --version · 57 unmodified lines
58	iptables 1.4.2 iptables -V	58	iptables 1.4.2 iptables -V
59	openssl & libcrypto 1.0.0 openssl version	59	openssl & libcrypto 1.0.0 openssl version
60	bc 1.06.95 bc --version	60	bc 1.06.95 bc --version
61	Sphinx\ [#f1]_ 1.7 sphinx-build --version	61	Sphinx\ [#f1]_ 2.4.4 sphinx-build --version
62	cpio any cpio --version	62	cpio any cpio --version
63	GNU tar 1.28 tar --version	63	GNU tar 1.28 tar --version
64	gtags (optional) 6.6.5 gtags --version	64	gtags (optional) 6.6.5 gtags --version

Documentation/sphinx/automarkup.py+1−5

@@ -7,11 +7,7 @@ · 6 unmodified lines
7	from docutils import nodes	7	from docutils import nodes
8	import sphinx	8	import sphinx
9	from sphinx import addnodes	9	from sphinx import addnodes
10	if sphinx.version_info[0] < 2 or \	10	from sphinx.errors import NoUri
11	sphinx.version_info[0] == 2 and sphinx.version_info[1] < 1:
12	from sphinx.environment import NoUri
13	else:
14	from sphinx.errors import NoUri
15	import re	11	import re
16	from itertools import chain	12	from itertools import chain
17		13

Documentation/sphinx/cdomain.py+1−5

@@ -127,11 +127,7 @@ def setup(app): · 126 unmodified lines
127		127
128	# Handle easy Sphinx 3.1+ simple new tags: :c:expr and .. c:namespace::	128	# Handle easy Sphinx 3.1+ simple new tags: :c:expr and .. c:namespace::
129	app.connect('source-read', c_markups)	129	app.connect('source-read', c_markups)
130		130	app.add_domain(CDomain, override=True)
131	if (major == 1 and minor < 8):
132	app.override_domain(CDomain)
133	else:
134	app.add_domain(CDomain, override=True)
135		131
136	return dict(	132	return dict(
137	version = __version__,	133	version = __version__,

Documentation/sphinx/kfigure.py+1−7

 from sphinx.util.nodes import clean_astext
 import kernellog
-# Get Sphinx version
+Figure = images.Figure
-major, minor, patch = sphinx.version_info[:3]
-if major == 1 and minor > 3:
-    # patches.Figure only landed in Sphinx 1.4
-    from sphinx.directives.patches import Figure  # pylint: disable=C0413
-else:
-    Figure = images.Figure
 __version__  = '1.0.0'

scripts/sphinx-pre-install+1−9

 my $activate_cmd;
 my $min_version;
 my $cur_version;
-my $rec_version = "1.7.9";	# PDF won't build here
+my $rec_version = "3.4.3";
-my $min_pdf_version = "2.4.4";	# Min version where pdf builds
 my $latest_avail_ver;
 #
 	# Version is OK. Nothing to do.
 	if ($cur_version && ($cur_version ge $rec_version)) {
-		if ($cur_version lt $min_pdf_version) {
-			print "note: If you want pdf, you need at least Sphinx $min_pdf_version.\n";
-		}
 		return;
 	};
 			printf "\t. $activate_cmd\n";
 			deactivate_help();
-			if ($latest_avail_ver lt $min_pdf_version) {
-				print "note: If you want pdf, you need at least Sphinx $min_pdf_version.\n";
-			}
 			return;
 		}