Re: [ptxdist] [PATCH 1/3] doc: fix CSS/JS files not getting picked up by sphinx 5.3.0

[Jonas Schmidt <j.schmidt@eckelmann.de>]

On Sat, May 06, 2023 at 10:22:21PM +0200, Roland Hieber 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>
We had a simular issue and I was workting on an fix as well, but you were faster.

Tested-by: Jonas Schmidt  <j.schmidt@eckelmann.de>
Acked-by: Jonas Schmidt  <j.schmidt@eckelaman>
> ---
>  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

Best regards
Jonas Schmidt.