Re: [ovs-dev] [PATCH] doc: Don't override default theme

[Matthew Thode via dev]

On 04/18/2017 05:26 AM, Stephen Finucane wrote:
> Sphinx 1.3 renamed the 'default' theme to 'classic' and configured the
> 'alabaster' theme as the new default. To prevent breaking existing
> builds, the 'default' name was reserved as an alias for 'classic' [1].
> However, initially this raised a warning [1] with a message to use
> 'classic' instead. This warning was removed in 1.3.2 [2], but it will
> result in errors (due to the use of the '-W' flag) for Sphinx 1.3.0 and
> 1.3.1 users.
> 
> Mitigate the issue by not setting a theme if the 'ovs_sphinx_theme'
> package is absent. This will result in Sphinx using its default theme,
> be that 'classic' (Sphinx < 1.3) or 'alabaster'.
> 
> [1] https://github.com/sphinx-doc/sphinx/commit/68021b0bd
> [2] https://github.com/sphinx-doc/sphinx/commit/034c4e942
> 
> Signed-off-by: Stephen Finucane 
> Cc: Matthew Thode 
> ---
> We might want to backport this if there are any releases with the Sphinx
> docs present.
> ---
>  Documentation/conf.py | 2 --
>  1 file changed, 2 deletions(-)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 49514ec..97f402e 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -145,8 +145,6 @@ linkcheck_anchors = False
>  #
>  if use_ovs_theme:
>  html_theme = 'ovs'
> -else:
> -html_theme = 'default'
>  
>  # 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
> 
Thanks for this, looks good and keeps default behaviour by default
instead of hard coding a default.

-- 
Matthew Thode

___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Re: [ovs-dev] [PATCH] doc: fix doc build when not using ovs theme

[Matthew Thode via dev]

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'

-- 
Matthew Thode

___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Re: [ovs-dev] [PATCH] doc: fix doc build when not using ovs theme

[Matthew Thode via dev]

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.

-- 
Matthew Thode

___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

[ovs-dev] [PATCH] doc: fix doc build when not using ovs theme

[Matthew Thode via dev]

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 
---
 Documentation/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 49514ec..8dffcf5 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -146,7 +146,7 @@ linkcheck_anchors = False
 if use_ovs_theme:
 html_theme = 'ovs'
 else:
-html_theme = 'default'
+html_theme = 'classic'
 
 # 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
-- 
2.10.2

___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev