| From: |
| Mauro Carvalho Chehab <mchehab+huawei-AT-kernel.org> |
| To: |
| Linux Doc Mailing List <linux-doc-AT-vger.kernel.org>, "Jonathan Corbet" <corbet-AT-lwn.net> |
| Subject: |
| [RFC 0/6] Raise the bar with regards to Python and Sphinx requirements |
| Date: |
| Wed, 29 Jan 2025 17:09:31 +0100 |
| Message-ID: |
| <cover.1738166451.git.mchehab+huawei@kernel.org> |
| Cc: |
| Mauro Carvalho Chehab <mchehab+huawei-AT-kernel.org>, Mauro Carvalho Chehab <mchehab+huawei-AT-kernel.org>, linux-kernel-AT-vger.kernel.org, Bill Wendling <morbo-AT-google.com>, Justin Stitt <justinstitt-AT-google.com>, Nick Desaulniers <ndesaulniers-AT-google.com>, bpf-AT-vger.kernel.org, llvm-AT-lists.linux.dev, workflows-AT-vger.kernel.org |
| Archive-link: |
| Article |
This series comes after https://lore.kernel.org/linux-doc/87a5b96296.fsf@trenco.l...
It increases the minimal requirements for Sphinx and Python.
Sphinx release dates:
Release 2.4.0 (released Feb 09, 2020)
Release 2.4.4 (released Mar 05, 2020) (current minimal requirement)
Release 3.4.0 (released Dec 20, 2020)
Release 3.4.3 (released Jan 08, 2021)
(https://www.sphinx-doc.org/en/master/changes/index.html)
In terms of Python, we're currently at 3.5:
Python Release date
3.5 2015-09-13 (current minimal requirement)
3.6 2016-12-23
3.7 2018-06-27
3.8 2019-10-14
3.9 2020-10-05
3.10 2021-10-04
(according with https://en.wikipedia.org/w/index.php?title=History_of_Python)
The new minimal requirements are now:
- Sphinx 3.4.3;
- Python 3.9
The new Sphinx minimal requirement allows dropping all backward-compatible code
we have at kernel-doc and at Sphinx extensions.
The new Python minimal requirement matches the current required level for
all scripts but one (*). The one that doesn't match is at tools/net/sunrpc/xdrgen.
Those matches a 4-years old toolchain, which sounds a reasonable period
of time, as Python/Sphinx aren't required for the Kernel build.
Mauro Carvalho Chehab (6):
scripts/get_abi.py: make it backward-compatible with Python 3.6
docs: extensions: don't use utf-8 syntax for descriptions
docs: automarkup: drop legacy support
scripts/kernel-doc: drop Sphinx version check
docs: changes: update Sphinx minimal version to 3.4.3
doc: changes: update Python minimal version
Documentation/conf.py | 2 +-
Documentation/process/changes.rst | 4 +-
Documentation/sphinx/automarkup.py | 32 ++---
Documentation/sphinx/cdomain.py | 7 +-
Documentation/sphinx/kernel_abi.py | 6 +-
Documentation/sphinx/kernel_feat.py | 4 +-
Documentation/sphinx/kernel_include.py | 4 +-
Documentation/sphinx/kerneldoc.py | 5 -
Documentation/sphinx/kfigure.py | 10 +-
Documentation/sphinx/load_config.py | 2 +-
Documentation/sphinx/maintainers_include.py | 4 +-
Documentation/sphinx/rstFlatTable.py | 10 +-
scripts/get_abi.py | 16 ++-
scripts/kernel-doc | 129 +++-----------------
14 files changed, 58 insertions(+), 177 deletions(-)
--
2.48.1
