From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH RFC] sphinx-static/theme_overrides.css: switch to a fixed width documentation
Date: Mon, 02 Feb 2026 11:47:30 +0100 [thread overview]
Message-ID: <20260202-fixed-width-html-v1-1-e987deb9926d@bootlin.com> (raw)
Change the css rules of our theme to have a fixed-width documentation
instead of it taking the full width of the page. I believe this makes it
much more readable compared to having long lines with few line returns,
especially on high-resolution displays. Set the width to 1000px instead
of the previous 800px, which felt slightly too thin.
I think the removed comment here does not make that much sense for us.
It was added by commit 0c1e108bc6c4 ("sphinx: add CSS theme override"),
and I believe is a simply copy and paste of what was is set in the Linux
kernel, added by commit 9abaf979abb2 ("doc-rst: customize RTD theme,
table & full width") [1].
[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=9abaf979abb2
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Note: this would require backports to stable branches to harmonize each
version of the documentation (perhaps outdated releases too) - either
manually or in an automated manner from the Autobuilder. We would also
have to update the BitBake manual's CSS file.
Note 2: I was hesitant as whether to center the text column or not. If
you want to try this is possible to do it by adding:
.wy-nav-content {
...
margin-left: auto;
margin-right: auto;
}
Note 3: I also tested this on my smartphone and it displays correctly.
---
documentation/sphinx-static/theme_overrides.css | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
diff --git a/documentation/sphinx-static/theme_overrides.css b/documentation/sphinx-static/theme_overrides.css
index d235cb826f..3cb16dbccc 100644
--- a/documentation/sphinx-static/theme_overrides.css
+++ b/documentation/sphinx-static/theme_overrides.css
@@ -99,14 +99,19 @@ em {
[alt='Permalink'] { color: #eee; }
[alt='Permalink']:hover { color: black; }
+.literal-block {
+ background: #f8f8f8;
+}
+
@media screen {
- /* content column
- *
- * RTD theme's default is 800px as max width for the content, but we have
- * tables with tons of columns, which need the full width of the view-port.
- */
+ .wy-nav-content {
+ max-width: 1000px;
+ background: #fcfcfc;
+ }
- .wy-nav-content{max-width: none; }
+ .wy-nav-content-wrap {
+ background: #efefef;
+ }
/* inline literal: drop the borderbox, padding and red color */
code, .rst-content tt, .rst-content code {
---
base-commit: b8a56b8b2e8c0417b2f7204f80c79b05d95e9ce4
change-id: 20260202-fixed-width-html-6e5d08767da8
next reply other threads:[~2026-02-02 10:47 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-02 10:47 Antonin Godard [this message]
2026-04-20 12:14 ` [PATCH RFC] sphinx-static/theme_overrides.css: switch to a fixed width documentation Antonin Godard
2026-04-24 8:42 ` Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260202-fixed-width-html-v1-1-e987deb9926d@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.