On Mon, Apr 17, 2017 at 11:47:30AM -0500, Matthew Thode wrote:
> On 04/17/2017 11:42 AM, Ben Pfaff wrote:
> > On Mon, Apr 17, 2017 at 11:32:13AM -0500, Matthew Thode wrote:
> >> On 04/17/2017 11:20 AM, Ben Pfaff wrote:
> >>> On Mon, Apr 17, 2017 at 10:36:26AM -0500, Matthew Thode via dev wrote:
> >>>> Fixes the following warning.
> >>>>
> >>>> WARNING: 'default' html theme has been renamed to 'classic'. Please
> >>>> change your
> >>>> html_theme setting either to the new 'alabaster' default theme, or to
> >>>> 'classic'
> >>>> to keep using the old default.
> >>>>
> >>>> As reported by https://bugs.gentoo.org/show_bug.cgi?id=614520
> >>>>
> >>>> Signed-off-by: Matthew Thode <mth...@mthode.org>
> >>>
> >>> Thanks. Do you know whether this is going to break the docs build for
> >>> people with older sphinx? That is, was "classic" introduced in sphinx
> >>> sometime after 1.1 (since that's the current minimum version for OVS)?
> >>>
> >> I'm not sure, the oldest version we have is 1.11.0, and the oldest
> >> stable version we support is 2.5.0. This is the first I've seen this
> >> bug reported though.
> >
> > I guess that you are talking about OVS versions, but I'm asking about
> > Sphinx versions. Does that make any difference? I don't know Sphinx
> > well at all.
> >
> I was talking about OVS versions. This code change only changes
> anything if sphinx is not installed.
>
> try:
> import ovs_sphinx_theme
> use_ovs_theme = True
> except ImportError:
> print("Cannot find 'ovs_sphinx' package. Falling back to default
> theme.")
> use_ovs_theme = False
>
> then
>
> if use_ovs_theme:
> html_theme = 'ovs'
> else:
> html_theme = 'default'
This code only runs at all if sphinx is installed, since it's
sphinx-build that runs it. The conditional is whether the OVS sphinx
theme is installed.
My question is, what version of Sphinx (not OVS, not the OVS sphinx
theme) introduced a theme named "classic"? If it is newer than the
oldest version of Sphinx that OVS requires, then this patch will break
things and we will need to make a choice:
1. Refine the patch to use "default" if "classic" is not
available.
2. Live with the warning.
3. Increase OVS's minimum required Sphinx version.
Thanks,
Ben.
_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
