Re: [PULL v2 0/1] readthedoc theme patch

["Marc-André Lureau" <marcandre.lureau@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 1861 bytes --]

Hi

On Thu, May 13, 2021 at 5:45 PM Peter Maydell <peter.maydell@linaro.org>
wrote:

> On Wed, 12 May 2021 at 20:31, Peter Maydell <peter.maydell@linaro.org>
> wrote:
> > I should be able to deal with this by installing the rtd theme on
> > the host. I'll retry merging the pullreq.
>
> On try 2 I find that some of my machines warn:
>
> Program qemu-keymap found: NO
> Program sphinx-build found: YES
> ../../docs/meson.build:30: WARNING: /usr/bin/sphinx-build:
> Theme error:
> unsupported theme option 'style_nav_header_background' given
>
> Program python3 found: YES (/usr/bin/python3)
> Program diff found: YES
>
> It looks like this is because it's trying to use an option
> that's only present in newer versions of the theme. (Ubuntu
> bionic has version 0.2.4 of the rtd theme.)
>
> Is it possible to either avoid or conditionalize the use of
> this config setting?
>
>
This should work, can you check?:

diff --git a/docs/conf.py b/docs/conf.py
index 3802b70d62..9e3d7cee0e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -29,6 +29,7 @@
 import os
 import sys
 import sphinx
+from packaging.version import parse as parse_version
 from sphinx.errors import ConfigError

 # Make Sphinx fail cleanly if using an old Python, rather than obscurely
@@ -162,7 +163,7 @@
 # Theme options are theme-specific and customize the look and feel of a
theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-if html_theme == 'sphinx_rtd_theme':
+if parse_version(sphinx_rtd_theme.__version__) >= parse_version('0.4.3'):
     html_theme_options = {
         "style_nav_header_background": "#802400",
     }

However, we agreed before to not have support fallbacks for missing deps.
Perhaps we should require rtd >= 0.4.3 instead?

thanks again!

-- 
Marc-André Lureau

[-- Attachment #2: Type: text/html, Size: 2690 bytes --]