Changes in sphinx-pre-install

9b8a79f4 - scripts: sphinx-pre-install: remove unnecessary double check for $cur_version

Tue, 27 Aug 2024 13:32:24 +0000

scripts: sphinx-pre-install: remove unnecessary double check for $cur_version$cur_version is currently being tested twice with the first testresulting in an unhelpful "$sphinx returned an error", not continuing tothe more helpful "$sphinx didn't return its version".This patch removes the first test to return the more useful message.Fixes: a8b380c379ef ("scripts: sphinx-pre-install: only ask to activate valid venvs")Signed-off-by: Sebastian Muxel Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240827133224.160776-1-sebastian@muxel.dev List of files: /linux-6.15/scripts/sphinx-pre-install

1cbd16e3 - scripts: sphinx-pre-install: Add pyyaml hint to other distros

Sat, 23 Mar 2024 12:58:38 +0000

scripts: sphinx-pre-install: Add pyyaml hint to other distrosExtend commit 84b4cc8189f2 ("docs: scripts: sphinx-pre-install: Fixbuilding docs with pyyaml package") and add pyyaml as an optionalpackage to Mageia, ArchLinux, and Gentoo.The Python module pyyaml is required to build the docs, but it is onlylisted in Documentation/sphinx/requirements.txt and is therefore missingwhen Sphinx is installed as a package and not via pip/pypi.Signed-off-by: Thorsten Blum Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240323125837.2022-2-thorsten.blum@toblux.com List of files: /linux-6.15/scripts/sphinx-pre-install

886f6cac - scripts/sphinx-pre-install: fix Arch xelatex dependency

Tue, 26 Mar 2024 10:45:15 +0000

scripts/sphinx-pre-install: fix Arch xelatex dependencyOn Arch Linux, xelatex is installed in the texlive-xetex package.Signed-off-by: Li Hua Link: https://lore.kernel.org/r/20240326104515.40346-1-lihua@email.comSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

b31274d5 - docs: drop the version constraints for sphinx and dependencies

Fri, 01 Mar 2024 14:18:00 +0000

docs: drop the version constraints for sphinx and dependenciesAs discussed (see Links), there is some inertia to move to the recentSphinx versions for the doc build environment.As first step, drop the version constraints and the related comments. Assphinx depends on jinja2, jinja2 is pulled in automatically. So drop that.Then, the sphinx-pre-install script will fail though with: Can't get default sphinx version from ./Documentation/sphinx/requirements.txt at ./scripts/sphinx-pre-install line 305.The script simply expects to parse a version constraint with Sphinx in therequirements.txt. That version is used in the script for suggesting thevirtualenv directory name.To suggest a virtualenv directory name, when there is no version given inthe requirements.txt, one could try to guess the version that would bedownloaded with 'pip install -r Documentation/sphinx/requirements.txt'.However, there seems no simple way to get that version without actuallysetting up the venv and running pip. So, instead, name the directory withthe fixed name 'sphinx_latest'.Finally update the Sphinx build documentation to reflect this directoryname change.Link: https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/Link: https://lore.kernel.org/linux-doc/20240226093854.47830-1-lukas.bulwahn@gmail.com/Reviewed-by: Akira Yokosawa Tested-by: Vegard Nossum Signed-off-by: Lukas Bulwahn Signed-off-by: Jonathan Corbet Message-ID: <20240301141800.30218-1-lukas.bulwahn@gmail.com> List of files: /linux-6.15/scripts/sphinx-pre-install

84b4cc81 - docs: scripts: sphinx-pre-install: Fix building docs with pyyaml package

Thu, 08 Feb 2024 20:55:51 +0000

docs: scripts: sphinx-pre-install: Fix building docs with pyyaml packageThe Python module pyyaml is required to build the docs, but it is onlylisted in Documentation/sphinx/requirements.txt and is therefore missingwhen Sphinx is installed as a package and not via pip/pypi.Add pyyaml as an optional package for multiple distros to fix building thedocs if you prefer to install Sphinx as a package.Signed-off-by: Thorsten Blum Reviewed-by: Vegard Nossum Tested-by: Vegard Nossum Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240208205550.984-1-thorsten.blum@toblux.com List of files: /linux-6.15/scripts/sphinx-pre-install

36443018 - docs: sphinx-pre-install fix-noto-sans-cjk on fedora

Wed, 24 Jan 2024 04:39:18 +0000

docs: sphinx-pre-install fix-noto-sans-cjk on fedorafedora 38 and later changed the directory and package name thatprovides NotoSansCJK-Regular.ttc. this adds the new search path andsuggests the correct package if on fedora 38 or later.Signed-off-by: Andrew Ballance Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240124043918.31771-1-andrewjballance@gmail.com List of files: /linux-6.15/scripts/sphinx-pre-install

3e893e16 - docs: Raise the minimum Sphinx requirement to 2.4.4

Fri, 08 Dec 2023 23:10:17 +0000

docs: Raise the minimum Sphinx requirement to 2.4.4Commit 31abfdda6527 (docs: Deprecate use of Sphinx < 2.4.x) in 6.2 added awarning that support for older versions of Sphinx would be going away.There have been no complaints, so the time has come. Raise the minimumSphinx version to 2.4.4 and clean out some compatibility code that we nolonger need.Reviewed-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/874jgs47fq.fsf@meer.lwn.netSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

df19817f - docs: sphinx-pre-install: don't require the RTD theme

Tue, 27 Sep 2022 16:45:50 +0000

docs: sphinx-pre-install: don't require the RTD themeWe don't default to the RTD theme anymore, so sphinx-pre-install need notinsist on installing it.Acked-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

02bba8ca - scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0

Sat, 02 Jul 2022 10:11:29 +0000

scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0Newer versions of Sphinx have a known bug: https://github.com/sphinx-doc/sphinx/pull/8313Those currently produces 11 false-positive warnings On Sphinxversion 3.1+.While Sphinx fix is not applied, let's warn adventurers that wouldbe using Sphinx installed via distro packages.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/085e0ada65c11da9303d07e70c510dc45f21315b.1656756450.git.mchehab@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

6a5d7320 - scripts: sphinx-pre-install: provide both venv and package installs

Sat, 02 Jul 2022 10:11:28 +0000

scripts: sphinx-pre-install: provide both venv and package installsAs it is not a consensus about installing sphinx using venv, andmodern distributions are now shipping with Sphinx versions abovethe minimal requirements to build the docs, provide both venvand package install commands by default.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/7c99d985df204c73e3daafd5fd2f30a31269405d.1656756450.git.mchehab@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

5b27d255 - scripts: sphinx-pre-install: check for PDF min version later on

Sat, 02 Jul 2022 10:11:27 +0000

scripts: sphinx-pre-install: check for PDF min version later onBetter to add the PDF note late for venv recommendation.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/8e117aabe6dfa1b1ec92dccd20e801393c977667.1656756450.git.mchehab@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

ed2133b7 - scripts: sphinx-pre-install: report broken venv

Sat, 02 Jul 2022 10:11:26 +0000

scripts: sphinx-pre-install: report broken venvAfter distro upgrades, the directory names for python may change.On such case, the previously-created venv will be broken, andsphinx-build won't run.Add a logic to report it.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/f117f03555b0636d2be0b68f3a23b1d3f03ccf1d.1656756450.git.mchehab@kernel.org[jc: fixed typo in warning message]Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

7c2d45a3 - scripts: sphinx-pre-install: fix venv version check logic

Sat, 02 Jul 2022 10:11:25 +0000

scripts: sphinx-pre-install: fix venv version check logicThe logic which checks if the venv version is good enoughbut was not activated is broken: it is checking againstthe wrong val, making it to recommend to re-create a venvevery time. Fix it.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/afe01b7863fd655986d84ace8948f3d7aede796d.1656756450.git.mchehab@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

87d6576d - scripts: sphinx-pre-install: Fix ctex support on Debian

Thu, 06 Jan 2022 00:41:02 +0000

scripts: sphinx-pre-install: Fix ctex support on DebianThe name of the package with ctexhook.sty is different onDebian/Ubuntu.Reported-by: Akira Yokosawa Signed-off-by: Mauro Carvalho Chehab Tested-by: Akira Yokosawa Link: https://lore.kernel.org/r/63882425609a2820fac78f5e94620abeb7ed5f6f.1641429634.git.mchehab@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

7baab965 - scripts: sphinx-pre-install: add required ctex dependency

Mon, 03 Jan 2022 21:01:57 +0000

scripts: sphinx-pre-install: add required ctex dependencyAfter a change meant to fix support for oriental characters(Chinese, Japanese, Korean), ctex stylesheet is now a requirementfor PDF output.Reported-by: Christoph Hellwig Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/165aa6167f21e3892a6e308688c93c756e94f4e0.1641243581.git.mchehab@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

a5f785f1 - scripts: sphinx-pre-install: fix the need of virtenv packages

Tue, 25 May 2021 13:27:28 +0000

scripts: sphinx-pre-install: fix the need of virtenv packagesThe pip packages are only needed when the distro-providedSphinx version is not good enough.Don't recommend installing it if not needed.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/04ce53b77b37f1e495c3abc39c2d3dc407895dc0.1621949137.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

e5089912 - scripts: sphinx-pre-install: rework the sphinx install logic

Tue, 25 May 2021 13:27:27 +0000

scripts: sphinx-pre-install: rework the sphinx install logicThe sphinx-pre-install supports installing sphinx via a virtualenvironment using pip/pypi or directly from the distribution'spackage, when --no-virtualenv is used.However, even when --no-virtualenv, the current logic isstill recomending to install a virtual env, due to a regression.It turns that the logic there is complex, as it depends onseveral different conditions.Split the code which recommends Sphinx on two separatefunctions, in order to clean up the code.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/9dedaec201803017b7a7dc24a074f3a4f040b72a.1621949137.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

e9dfeed2 - docs: sphinx-pre-install: don't barf on beta Sphinx releases

Thu, 15 Apr 2021 22:01:50 +0000

docs: sphinx-pre-install: don't barf on beta Sphinx releasessphinx-pre-install is picky when it comes to parsing sphinx versions; itfailed when run with sphinx 4.0.0b1. Tweak the regex to tolerate atrailing "bN" on the version number.Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

4217e507 - Docs: drop Python 2 support

Tue, 02 Feb 2021 00:17:14 +0000

Docs: drop Python 2 supportThe kernel build system as a whole is dropping support for Python 2, so weshould do the same. The effects are rather small, especially consideringthat much of the deleted code was not doing anything under any version ofPython anyway.Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/sphinx-pre-install

c25ce589 - tweewide: Fix most Shebang lines

Mon, 23 Nov 2020 14:15:33 +0000

tweewide: Fix most Shebang linesChange every shebang which does not need an argument to use /usr/bin/env.This is needed as not every distro has everything under /usr/bin,sometimes not even bash.Signed-off-by: Finn Behrens Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/sphinx-pre-install