-
Randy Dunlap authored
Convert the Documentation front page to use the heading adornments that are documented in doc-guide/sphinx.rst for document title and chapters. I.e., convert most section headings to chapters. This leaves "Indices and tables" as a chapter entry at the same level as the other chapters. The only visual difference from before to after is that the "Indices and tables" heading is smaller and has more vertical whitespace preceding it (although that may depend on the web browser being used). Fixes: 0c7b4366 ("docs: Rewrite the front page") Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/20230215005726.27320-1-rdunlap@infradead.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
Randy Dunlap authoredConvert the Documentation front page to use the heading adornments that are documented in doc-guide/sphinx.rst for document title and chapters. I.e., convert most section headings to chapters. This leaves "Indices and tables" as a chapter entry at the same level as the other chapters. The only visual difference from before to after is that the "Indices and tables" heading is smaller and has more vertical whitespace preceding it (although that may depend on the web browser being used). Fixes: 0c7b4366 ("docs: Rewrite the front page") Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/20230215005726.27320-1-rdunlap@infradead.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
The Linux Kernel documentation
This is the top level of the kernel's documentation tree. Kernel documentation, like the kernel itself, is very much a work in progress; that is especially true as we work to integrate our many scattered documents into a coherent whole. Please note that improvements to the documentation are welcome; join the linux-doc list at vger.kernel.org if you want to help out.
Working with the development community
The essential guides for interacting with the kernel's development community and getting your work upstream.
Internal API manuals
Manuals for use by developers working to interface with the rest of the kernel.
Development tools and processes
Various other manuals with useful information for all kernel developers.
User-oriented documentation
The following manuals are written for users of the kernel — those who are trying to get it to work optimally on a given system and application developers seeking information on the kernel's user-space APIs.
See also: the Linux man pages, which are kept separately from the kernel's own documentation.
Firmware-related documentation
The following holds information on the kernel's expectations regarding the platform firmwares.
Architecture-specific documentation
Other documentation
There are several unsorted documents that don't seem to fit on other parts of the documentation body, or may require some adjustments and/or conversion to ReStructured Text format, or are simply too old.
Translations
Indices and tables
- :ref:`genindex`