mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2026-09-22 09:34:56 +02:00
Vegard Nossum
a4f58d70f2
The "toc-title" class was introduced in commitef88f10eb8("[media] doc-rst: backward compatibility with older Sphinx versions") as a workaround for Sphinx versions older than 1.4.x. However, these old versions have been deprecated since commit31abfdda65("docs: Deprecate use of Sphinx < 2.4.x"). Having now changed all the toc-title users to use the :caption: attribute, we can also remove the custom style. Note that the toc-title class is separate from the "kernel-toc" logic that was introduced in commitc404f5d4f0("docs: Add more information to the HTML sidebar"). Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20231027081830.195056-12-vegard.nossum@oracle.com
Linux kernel
============
There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.
In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/
There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.