From: Roland Hieber <rhi@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [ptxdist] [PATCH 1/3] doc: fix CSS/JS files not getting picked up by sphinx 5.3.0
Date: Sat, 6 May 2023 22:22:21 +0200 [thread overview]
Message-ID: <20230506202223.263380-1-rhi@pengutronix.de> (raw)
Somewhen between v3.4.3 (Debian bullseye) and v5.3.0 (Debian bookworm),
sphinx stopped picking up our CSS and JS files from the html_context,
which has the effect that the styling of the HTML documentation looks
very broken when built with sphinx 5.3.0.
Instead of injecting the CSS and JS files into html_context, use the
dedicated variables html_css_files and html_js_files, which were
introduced in sphinx 1.8 (which came out in 2018). This mostly fixes the
layout with sphinx v5.3.0, apart from a small vertical space glitch in
the "View page source" link, which we will fix later.
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
doc/conf.py | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index 92594f4078a0..3e53aa4db20e 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -172,15 +172,16 @@ html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
-html_context = {
- 'css_files': ['_static/css/custom.css'],
- 'script_files': [
- '_static/js/jquery-3.1.0.min.js',
- '_static/underscore.js',
- '_static/doctools.js',
- '_static/js/main.js',
- ],
-}
+html_css_files = [
+ 'css/custom.css',
+]
+
+html_js_files = [
+ 'js/jquery-3.1.0.min.js',
+ 'underscore.js',
+ 'doctools.js',
+ 'js/main.js',
+]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
--
2.39.2
next reply other threads:[~2023-05-06 20:23 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-06 20:22 Roland Hieber [this message]
2023-05-06 20:22 ` [ptxdist] [PATCH 2/3] doc: custom.css: fix indentation Roland Hieber
2023-05-11 5:55 ` [ptxdist] [APPLIED] " Michael Olbrich
2023-05-06 20:22 ` [ptxdist] [PATCH 3/3] doc: custom.css: fix "View Page Source" align with newer sphinx_rtd_theme Roland Hieber
2023-05-11 5:55 ` [ptxdist] [APPLIED] " Michael Olbrich
2023-05-11 5:55 ` [ptxdist] [APPLIED] doc: fix CSS/JS files not getting picked up by sphinx 5.3.0 Michael Olbrich
2023-05-15 10:21 ` [ptxdist] [PATCH 1/3] " Jonas Schmidt
2023-05-15 11:18 ` Gavin Schenk
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=20230506202223.263380-1-rhi@pengutronix.de \
--to=rhi@pengutronix.de \
--cc=ptxdist@pengutronix.de \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox