]> git.baikalelectronics.ru Git - kernel.git/commit
docs: update recommended Sphinx version to 2.4.4
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 14 Apr 2020 16:48:30 +0000 (18:48 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 20 Apr 2020 21:35:58 +0000 (15:35 -0600)
commit6eb59759c3ebb640cdeb49539c53ce1bbbc8719d
tree968e757534996e7e63f2548605e45ed6832c2cda
parent6e5aa4e6f124799f6a52ff7676e80f272f874125
docs: update recommended Sphinx version to 2.4.4

There are some docs that have nested tables. While this was
always part of the spec, only Sphinx version 2.4.x can
translate it to LaTeX.

In other words, if someone is using a Sphinx version < 2.4,
the LaTeX and PDF output won't work for some of the docs.

So, it seems that it is time to raise the bar again
for the recommented version.

The Sphinx check script is already smart enough to keep
working, with older versions, warning the users that
an upgrade is recommended (and explaining how):

Sphinx version 1.7.9
Warning: It is recommended at least Sphinx version 2.4.4.
Detected OS: Fedora release 31 (Thirty One).

To upgrade Sphinx, use:

/usr/bin/virtualenv sphinx_2.4.4
. sphinx_2.4.4/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/498f701c618f7d0cf5f0a37e5889ee926f7c8bf4.1586881715.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/sphinx/requirements.txt