]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: allow inline literals in paragraphs to wrap to prevent overflow
authorRito Rhymes <rito@ritovision.com>
Mon, 23 Mar 2026 15:14:01 +0000 (11:14 -0400)
committerJonathan Corbet <corbet@lwn.net>
Wed, 25 Mar 2026 19:16:58 +0000 (13:16 -0600)
Some documentation pages contain long inline literals in paragraph
text that can force page-wide horizontal scroll overflow and break
layout on smaller screens.

Override the default `span.pre` white-space behavior for inline
literals and use `overflow-wrap: anywhere` so they can wrap when
needed. For code used as part of a paragraph, wrapping is appropriate
because it is stylistically part of the surrounding text. Code blocks,
by contrast, are meant to preserve formatting fidelity and are better
served by contained horizontal scrolling.

Examples:
  https://docs.kernel.org/6.15/userspace-api/futex2.html
  https://docs.kernel.org/6.15/security/IMA-templates.html

Signed-off-by: Rito Rhymes <rito@ritovision.com>
Assisted-by: Codex:GPT-5.4
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260323151401.27415-1-rito@ritovision.com>

Documentation/sphinx-static/custom.css

index db24f4344e6cff64b958f702f2948e0bbb7dcf5a..dd69df2a7f57a637a482afab48b2b670de530cc0 100644 (file)
@@ -149,6 +149,15 @@ div.language-selection ul li:hover {
     background: #dddddd;
 }
 
+/*
+ * Let long inline literals in paragraph text wrap as needed to prevent
+ * overflow.
+ */
+code.docutils.literal span.pre {
+    white-space: normal;
+    overflow-wrap: anywhere;
+}
+
 /* Make xrefs more universally visible */
 a.reference, a.reference:hover {
     border-bottom: none;