diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2022-09-30 11:52:09 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2022-09-30 12:01:23 -0600 |
| commit | 7e473c402adfbf7b9f404573f8f59d024a8a2f64 (patch) | |
| tree | 4d427e5f0fd4728823aaface130ac2211bfad74e /Documentation | |
| parent | e4fffa20dd4ce947cb0736ab4f176f463dfaecf6 (diff) | |
| download | lwn-alabaster.tar.gz lwn-alabaster.zip | |
docs: improve the HTML formatting of kerneldoc commentsalabaster
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. Tweak a
few other CSS parameters while in the neighborhood to improve the
formatting.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/sphinx-static/custom.css | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css index c465251e840a..eada9deb29c7 100644 --- a/Documentation/sphinx-static/custom.css +++ b/Documentation/sphinx-static/custom.css @@ -10,3 +10,16 @@ div.body h3 { font-size: 130%; } /* Tighten up the layout slightly */ div.body { padding: 0 15px 0 10px; } + +/* Don't force the document width */ +div.document { width: auto; max-width: 60em; } + +/* + * Parameters for the display of function prototypes and such included + * from C source files. + */ +dl.function { 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.kernelfunc { margin-left: 2em; margin-right: 4em; } |