]> git.proxmox.com Git - mirror_ovs.git/commit
doc: Don't override default theme
authorStephen Finucane <stephen@that.guru>
Tue, 18 Apr 2017 10:26:49 +0000 (11:26 +0100)
committerBen Pfaff <blp@ovn.org>
Fri, 21 Apr 2017 21:30:43 +0000 (14:30 -0700)
commitf631f6e95998b01720504c548651be276d47c23a
treef413f72c32579d56937a2726930d8ab6618e7b87
parent47f1bb15668dd2a5190ee1b8f9bca7d0748df077
doc: Don't override default theme

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 <stephen@that.guru>
Cc: Matthew Thode <mthode@mthode.org>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Documentation/conf.py