summaryrefslogtreecommitdiffstats
path: root/Documentation/sphinx-static
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2022-09-30 11:52:09 -0600
committerJonathan Corbet <corbet@lwn.net>2022-10-18 16:29:29 -0600
commiteaf710ceb5ae284778a87c0d0f2348c19e3e4751 (patch)
tree1629c8c63da18b4bd5260c6b4e5ab530078b5eaf /Documentation/sphinx-static
parentdf19817f3ff3de28e87139b6d172c0094402e1f2 (diff)
downloadlinux-stable-eaf710ceb5ae284778a87c0d0f2348c19e3e4751.tar.gz
linux-stable-eaf710ceb5ae284778a87c0d0f2348c19e3e4751.tar.bz2
linux-stable-eaf710ceb5ae284778a87c0d0f2348c19e3e4751.zip
docs: improve the HTML formatting of kerneldoc comments
Make a few changes to cause functions documented by kerneldoc to stand out better in the rendered documentation. Specifically, change kernel-doc to put the description section into a ".. container::" section, then add a bit of CSS to indent that section relative to the function prototype (or struct or enum definition). Tweak a few other CSS parameters while in the neighborhood to improve the formatting. Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/sphinx-static')
-rw-r--r--Documentation/sphinx-static/custom.css16
1 files changed, 15 insertions, 1 deletions
diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css
index 6b0e554cea0a..9b36f7abd24f 100644
--- a/Documentation/sphinx-static/custom.css
+++ b/Documentation/sphinx-static/custom.css
@@ -10,5 +10,19 @@ div.body h3 { font-size: 130%; }
/* Tighten up the layout slightly */
div.body { padding: 0 15px 0 10px; }
-div.document { margin: 20px 10px 0 10px; }
div.sphinxsidebarwrapper { padding: 1em 0.4em; }
+/* Tweak document margins and don't force width */
+div.document {
+ margin: 20px 10px 0 10px;
+ width: auto;
+}
+
+/*
+ * Parameters for the display of function prototypes and such included
+ * from C source files.
+ */
+dl.function, dl.struct, dl.enum { margin-top: 2em; background-color: #ecf0f3; }
+/* indent lines 2+ of multi-line function prototypes */
+dl.function dt { margin-left: 10em; text-indent: -10em; }
+dt.sig-object { font-size: larger; }
+div.kernelindent { margin-left: 2em; margin-right: 4em; }