2021-11-27 09:16:57

by Mauro Carvalho Chehab

Subject: [PATCH v2 1/1] docs: conf.py: fix support for Readthedocs v 1.0.0

As described at:
https://stackoverflow.com/questions/23211695/modifying-content-width-of-the-sphinx-theme-read-the-docs

since Sphinx 1.8, the standard way to setup a custom theme is
to use html_css_files. While using html_context is OK with RTD
0.5.2, it doesn't work with 1.0.0, causing the theme to not load,
producing a very weird html.

Tested with:
- Sphinx 1.7.9 + sphinx-rtd-theme 0.5.2
- Sphinx 2.4.4 + sphinx-rtd-theme 0.5.2
- Sphinx 2.4.4 + sphinx-rtd-theme 1.0.0
- Sphinx 4.3.0 + sphinx-rtd-theme 1.0.0

Reported-by: Hans Verkuil <[email protected]>
Tested-by: Hans Verkuil <[email protected]>
Reviewed-by: Laurent Pinchart <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---

See [PATCH v2 0/1] at: https://lore.kernel.org/all/[email protected]/

Documentation/conf.py | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 17f7cee56987..76e5eb5cb62b 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -249,11 +249,16 @@ except ImportError:

html_static_path = ['sphinx-static']

-html_context = {
- 'css_files': [
- '_static/theme_overrides.css',
- ],
-}
+html_css_files = [
+ 'theme_overrides.css',
+]
+
+if major <= 1 and minor < 8:
+ html_context = {
+ 'css_files': [
+ '_static/theme_overrides.css',
+ ],
+ }

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
--
2.33.1

2021-11-27 12:15:29

by Akira Yokosawa

Subject: Re: [PATCH v2 1/1] docs: conf.py: fix support for Readthedocs v 1.0.0

On Sat, 27 Nov 2021 10:14:49 +0100, Mauro Carvalho Chehab wrote:
> As described at:
> https://stackoverflow.com/questions/23211695/modifying-content-width-of-the-sphinx-theme-read-the-docs
>
> since Sphinx 1.8, the standard way to setup a custom theme is
> to use html_css_files. While using html_context is OK with RTD
> 0.5.2, it doesn't work with 1.0.0, causing the theme to not load,
> producing a very weird html.
>
> Tested with:
> - Sphinx 1.7.9 + sphinx-rtd-theme 0.5.2
> - Sphinx 2.4.4 + sphinx-rtd-theme 0.5.2
> - Sphinx 2.4.4 + sphinx-rtd-theme 1.0.0
> - Sphinx 4.3.0 + sphinx-rtd-theme 1.0.0
>
> Reported-by: Hans Verkuil <[email protected]>
> Tested-by: Hans Verkuil <[email protected]>
> Reviewed-by: Laurent Pinchart <[email protected]>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
>
> See [PATCH v2 0/1] at: https://lore.kernel.org/all/[email protected]/

Hi Mauro,

Good to see the nice looking HTML pages as before!

Tested-by: Akira Yokosawa <[email protected]>

Thanks, Akira

>
> Documentation/conf.py | 15 ++++++++++-----
> 1 file changed, 10 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 17f7cee56987..76e5eb5cb62b 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -249,11 +249,16 @@ except ImportError:
>
> html_static_path = ['sphinx-static']
>
> -html_context = {
> - 'css_files': [
> - '_static/theme_overrides.css',
> - ],
> -}
> +html_css_files = [
> + 'theme_overrides.css',
> +]
> +
> +if major <= 1 and minor < 8:
> + html_context = {
> + 'css_files': [
> + '_static/theme_overrides.css',
> + ],
> + }
>
> # Add any extra paths that contain custom files (such as robots.txt or
> # .htaccess) here, relative to this directory. These files are copied
>