Re: [PATCH] docs/conf.py: Remove usage of distutils

[Peter Maydell]

On Mon, 4 Mar 2024 at 09:36, Thomas Huth <thuth@redhat.com> wrote:
>
> The macOS jobs in our CI recently started failing, complaining that
> the distutils module is not available anymore. And indeed, according to
> https://peps.python.org/pep-0632/ it's been deprecated since a while
> and now likely got removed in recent Python versions.
>
> Fortunately, we only use it for a version check via LooseVersion here
> which we don't really need anymore: All distros ship newer versions of
> Sphinx now (see https://repology.org/project/python:sphinx/versions -
> the oldest one is 0.6.6 on CentOS 6!), so we can simply drop the version
> check now.

This code isn't checking the Sphinx version (we do that via the
setting of needs_sphinx, current minimum 1.6), but the
sphinx-rtd-theme version, which is independent of Sphinx's
version numbering scheme.

I get timeouts trying to connect to repology.org, so can't check:
do distros all ship new enough versions of sphinx-rtd-theme yet?

> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  docs/conf.py | 10 ++++------
>  1 file changed, 4 insertions(+), 6 deletions(-)
>
> diff --git a/docs/conf.py b/docs/conf.py
> index e84a95e71c..1b2afa241c 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -29,7 +29,6 @@
>  import os
>  import sys
>  import sphinx
> -from distutils.version import LooseVersion
>  from sphinx.errors import ConfigError
>
>  # The per-manual conf.py will set qemu_docdir for a single-manual build;
> @@ -165,11 +164,10 @@
>  # 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 LooseVersion(sphinx_rtd_theme.__version__) >= LooseVersion("0.4.3"):
> -    html_theme_options = {
> -        "style_nav_header_background": "#802400",
> -        "navigation_with_keys": True,
> -    }
> +html_theme_options = {
> +    "style_nav_header_background": "#802400",
> +    "navigation_with_keys": True,
> +}
>
>  html_logo = os.path.join(qemu_docdir, "../ui/icons/qemu_128x128.png")

thanks
-- PMM