From mboxrd@z Thu Jan  1 00:00:00 1970
Delivery-date: Thu, 11 May 2023 07:56:17 +0200
Received: from metis.ext.pengutronix.de ([2001:67c:670:201:290:27ff:fe1d:cc33])
	by lore.white.stw.pengutronix.de with esmtps  (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
	(Exim 4.94.2)
	(envelope-from <ptxdist-bounces+lore=lore.pengutronix.de@pengutronix.de>)
	id 1pwzHm-00DZlE-DZ
	for lore@lore.pengutronix.de; Thu, 11 May 2023 07:56:17 +0200
Received: from localhost ([127.0.0.1] helo=metis.ext.pengutronix.de)
	by metis.ext.pengutronix.de with esmtp (Exim 4.92)
	(envelope-from <ptxdist-bounces@pengutronix.de>)
	id 1pwzHj-0001xe-Nd; Thu, 11 May 2023 07:56:15 +0200
Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2])
 by metis.ext.pengutronix.de with esmtps
 (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92)
 (envelope-from <mol@pengutronix.de>)
 id 1pwzH4-0001dH-Dt; Thu, 11 May 2023 07:55:34 +0200
Received: from [2a0a:edc0:0:1101:1d::54] (helo=dude05.red.stw.pengutronix.de)
 by drehscheibe.grey.stw.pengutronix.de with esmtp (Exim 4.94.2)
 (envelope-from <mol@pengutronix.de>)
 id 1pwzH3-002efd-PP; Thu, 11 May 2023 07:55:33 +0200
Received: from mol by dude05.red.stw.pengutronix.de with local (Exim 4.94.2)
 (envelope-from <mol@pengutronix.de>)
 id 1pwzH3-008JBC-1W; Thu, 11 May 2023 07:55:33 +0200
From: Michael Olbrich <m.olbrich@pengutronix.de>
To: ptxdist@pengutronix.de
Date: Thu, 11 May 2023 07:55:33 +0200
Message-Id: <20230511055533.1980343-1-m.olbrich@pengutronix.de>
X-Mailer: git-send-email 2.39.2
In-Reply-To: <20230506202223.263380-1-rhi@pengutronix.de>
References: <20230506202223.263380-1-rhi@pengutronix.de>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: Re: [ptxdist] [APPLIED] doc: fix CSS/JS files not getting picked up
 by sphinx 5.3.0
X-BeenThere: ptxdist@pengutronix.de
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: PTXdist Development Mailing List <ptxdist.pengutronix.de>
List-Unsubscribe: <http://metis.pengutronix.de/cgi-bin/mailman/options/ptxdist>, 
 <mailto:ptxdist-request@pengutronix.de?subject=unsubscribe>
List-Archive: <http://metis.pengutronix.de/cgi-bin/mailman/private/ptxdist/>
List-Post: <mailto:ptxdist@pengutronix.de>
List-Help: <mailto:ptxdist-request@pengutronix.de?subject=help>
List-Subscribe: <http://metis.pengutronix.de/cgi-bin/mailman/listinfo/ptxdist>, 
 <mailto:ptxdist-request@pengutronix.de?subject=subscribe>
Reply-To: ptxdist@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Sender: "ptxdist" <ptxdist-bounces@pengutronix.de>
X-SA-Exim-Connect-IP: 127.0.0.1
X-SA-Exim-Mail-From: ptxdist-bounces@pengutronix.de
X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false

Thanks, applied as 244182364d60903ae07e2a2a583ea025d097426d.

Michael

[sent from post-receive hook]

On Thu, 11 May 2023 07:55:32 +0200, Roland Hieber <rhi@pengutronix.de> wrote:
> 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>
> Message-Id: <20230506202223.263380-1-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> 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".