]> git.baikalelectronics.ru Git - kernel.git/commit
Merge branch 'fp' into docs-mw
authorJonathan Corbet <corbet@lwn.net>
Thu, 29 Sep 2022 18:55:45 +0000 (12:55 -0600)
committerJonathan Corbet <corbet@lwn.net>
Thu, 29 Sep 2022 18:55:45 +0000 (12:55 -0600)
commitd07ff906819e28abedc3fd30353d541a4e785407
treeadb1ba6f37426346484e37166375ff29ce64cac1
parent964cb31413ac885485b08c9df50203c10cd21703
parenta1667232a4ab2331e69bfde8d90afee25bb1624a
Merge branch 'fp' into docs-mw

The top-level index.rst file is the entry point for the kernel's
documentation, especially for readers of the HTML output.  It is currently
a mess containing everything we thought to throw in there.  Firefox says it
would require 26 pages of paper to print it.  That is not a user-friendly
introduction.

This series aims to improve our documentation entry point with a focus on
rewriting index.rst.  The result is, IMO, simpler and more approachable.
For anybody who wants to see the rendered results without building the
docs, have a look at:

  https://static.lwn.net/kerneldoc/

This time around I've rendered the pages using the "Read The Docs" theme,
since that's what everybody will get by default.  That theme ignores the
directives regarding the left column, so the results are not as good there.
I have a series proposing a default-theme change in the works, but that's a
separate topic.

This is only a beginning; I think this kind of organizational effort has to
be pushed down into the lower layers of the docs tree itself.  But one has
to start somewhere.