docs: Add function signature line breaks

Change-Id: I332ba1fa206ea76f3a7aa4cc2d3a0dfad7f254cb Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/168554 Commit-Queue: Kayce Basques <[email protected]> Pigweed-Auto-Submit: Kayce Basques <[email protected]> Commit-Queue: Anthony DiGirolamo <[email protected]> Reviewed-by: Kayce Basques <[email protected]>
google · Aug 25, 2023 · 98eda46 · 98eda46
1 parent 50ec0b1
commit 98eda46
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/_static/css/pigweed.css b/docs/_static/css/pigweed.css
@@ -27,6 +27,7 @@
 
 .sidebar-brand-text {
   font-size: 2.5rem;
+  text-align: center;
 }
 
 /********** General document coloring ***********/
@@ -78,6 +79,12 @@ dl.describe>dt {
     text-indent: 0em;
 }
 
+/* Remove blank space before/after function signature open/close parens. */
+.sig > dl {
+    margin-block-start: 0;
+    margin-block-end: 0;
+}
+
 /* Make inline code standout more */
 code.literal {
   border: 1px solid var(--color-inline-code-border);

diff --git a/docs/conf.py b/docs/conf.py
@@ -282,6 +282,11 @@
 # Disable Python type hints
 # autodoc_typehints = 'none'
 
+# Break class and function signature arguments into one arg per line if the
+# total length exceeds 130 characters. 130 seems about right for keeping one or
+# two parameters on a single line.
+maximum_signature_line_length = 130
+
 
 def do_not_skip_init(app, what, name, obj, would_skip, options):
     if name == "__init__":