kernel/linux.git/Documentation/sphinx/templates/kernel-toc.html, branch v6.12.80Linux kernel stable tree (mirror)https://git.radix-linux.su/kernel/linux.git/atom?h=v6.12.802024-01-23T21:33:13+00:00docs/sphinx: Fix TOC scroll hack for the home page2024-01-23T21:33:13+00:00Gustavo Sousagustavo.sousa@intel.com2024-01-23T16:21:58+00:00urn:sha1:d2d0223441d3caad65f6978c07869321bce968e0
When on the documentation home page, there won't be any ".current"
element since no entry from the TOC was selected yet. That results in a
javascript error. Fix that by only trying to set the scrollTop if we
have matches for current entries.
Signed-off-by: Gustavo Sousa <gustavo.sousa@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240123162157.61819-2-gustavo.sousa@intel.com
docs: Use HTML comments for the kernel-toc SPDX line2023-02-16T23:06:44+00:00Jonathan Corbetcorbet@lwn.net2023-02-16T23:06:44+00:00urn:sha1:4e98799a7021b51d1e641a8150ef71ef90c756ab
This line was initially placed in {# jinja2 comments #}, but that led to an
"invalid token" complaint from spdxcheck.py. Rather than fix the script
for a usage we'll likely never see anywhere else, just switch to an HTML
comment, which spdxcheck.py thinks is fine.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: Add more information to the HTML sidebar2023-02-08T20:28:27+00:00Jonathan Corbetcorbet@lwn.net2023-01-20T00:03:05+00:00urn:sha1:c404f5d4f0993e9d75a4de5a91280e9cb2419281
Add a new sidebar template that creates a more RTD-like "fisheye" view of
the current place in the document hierarchy. It is far from ideal, but
some readers may find it better for navigating through the documentation as
a whole.
Add some CSS trickery as well to make the table of contents less intrusive
when viewing the pages on a small screen.
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Reviewed-by: David Gow <davidgow@google.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>