2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-17 01:34:00 +08:00
linux-next/Documentation/sphinx
Mauro Carvalho Chehab d5afc9640a 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>
2020-04-20 15:35:58 -06:00
..
automarkup.py docs: Keep up with the location of NoUri 2020-01-24 09:47:05 -07:00
cdomain.py docs: cdomain.py: get rid of a warning since version 1.8 2019-05-29 15:47:32 -06:00
kernel_include.py docs: sphinx-extensions: add metadata parallel-safe 2016-09-01 08:19:02 -06:00
kerneldoc.py kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers' 2019-11-07 13:17:25 -07:00
kernellog.py doc: Cope with Sphinx logging deprecations 2019-05-23 09:22:00 -06:00
kfigure.py doc: Cope with Sphinx logging deprecations 2019-05-23 09:22:00 -06:00
load_config.py docs: load_config.py: ensure subdirs end with "/" 2019-07-19 08:49:27 -03:00
maintainers_include.py doc-rst: Programmatically render MAINTAINERS into ReST 2019-10-02 10:03:17 -06:00
parallel-wrapper.sh docs: Fix empty parallelism argument 2020-02-25 03:11:04 -07:00
parse-headers.pl doc:sphinx: fix parse-header description 2018-06-26 09:07:57 -06:00
requirements.txt docs: update recommended Sphinx version to 2.4.4 2020-04-20 15:35:58 -06:00
rstFlatTable.py Documentation: rstFlatTable.py: fix a broken reference 2018-06-15 18:10:01 -03:00