Skip to content

Commit

Permalink
docs: Raise the minimum Sphinx requirement to 2.4.4
Browse files Browse the repository at this point in the history
Commit 31abfdd (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.

Reviewed-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/874jgs47fq.fsf@meer.lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Jonathan Corbet committed Dec 15, 2023
1 parent 5070957 commit 3e893e1
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 29 deletions.
2 changes: 1 addition & 1 deletion Documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def have_command(cmd):
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.7'
needs_sphinx = '2.4.4'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down
2 changes: 1 addition & 1 deletion Documentation/doc-guide/sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Sphinx Install
==============

The ReST markups currently used by the Documentation/ files are meant to be
built with ``Sphinx`` version 1.7 or higher.
built with ``Sphinx`` version 2.4.4 or higher.

There's a script that checks for the Sphinx requirements. Please see
:ref:`sphinx-pre-install` for further details.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/process/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ mcelog 0.6 mcelog --version
iptables 1.4.2 iptables -V
openssl & libcrypto 1.0.0 openssl version
bc 1.06.95 bc --version
Sphinx\ [#f1]_ 1.7 sphinx-build --version
Sphinx\ [#f1]_ 2.4.4 sphinx-build --version
cpio any cpio --version
GNU tar 1.28 tar --version
gtags (optional) 6.6.5 gtags --version
Expand Down
6 changes: 1 addition & 5 deletions Documentation/sphinx/automarkup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@
from docutils import nodes
import sphinx
from sphinx import addnodes
if sphinx.version_info[0] < 2 or \
sphinx.version_info[0] == 2 and sphinx.version_info[1] < 1:
from sphinx.environment import NoUri
else:
from sphinx.errors import NoUri
from sphinx.errors import NoUri
import re
from itertools import chain

Expand Down
6 changes: 1 addition & 5 deletions Documentation/sphinx/cdomain.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,7 @@ def setup(app):

# Handle easy Sphinx 3.1+ simple new tags: :c:expr and .. c:namespace::
app.connect('source-read', c_markups)

if (major == 1 and minor < 8):
app.override_domain(CDomain)
else:
app.add_domain(CDomain, override=True)
app.add_domain(CDomain, override=True)

return dict(
version = __version__,
Expand Down
8 changes: 1 addition & 7 deletions Documentation/sphinx/kfigure.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,7 @@
from sphinx.util.nodes import clean_astext
import kernellog

# Get Sphinx version
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
Figure = images.Figure

__version__ = '1.0.0'

Expand Down
10 changes: 1 addition & 9 deletions scripts/sphinx-pre-install
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ my $python_cmd = "";
my $activate_cmd;
my $min_version;
my $cur_version;
my $rec_version = "1.7.9"; # PDF won't build here
my $min_pdf_version = "2.4.4"; # Min version where pdf builds
my $rec_version = "3.4.3";
my $latest_avail_ver;

#
Expand Down Expand Up @@ -791,9 +790,6 @@ sub recommend_sphinx_version($)

# 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;
};

Expand Down Expand Up @@ -842,10 +838,6 @@ sub recommend_sphinx_version($)
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;
}

Expand Down

0 comments on commit 3e893e1

Please sign in to comment.