[openstack-dev] [all] Sphinx 1.3 is coming, breaking almost every docs

Thomas Goirand zigo at debian.org
Fri May 29 12:56:15 UTC 2015


Hi,

Currently, in the global requirements, we have:
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3

However, like it or not, sphinx 1.3 will soon reach Debian unstable.
Already, I see something broken with it:
https://gist.github.com/mitya57/1643a7c1666b650a0de5

(if you didn't notice, that's sphinxcontrib-programoutput)

sphinxcontrib-programoutput breaks *only* because the html theme needs
to be called 'classic' instead of 'default'. To make things worse, the
'classic' theme isn't available in version 1.2 of Sphinx.

So we need to fix things before they break badly. I have suggested to
the python-sphinx package maintainer to make the transition better than
upstream. Maybe just remove the warning, which may (like above) wrongly
taken as a hard fail? Then maybe get reverse dependencies check if the
classic theme is available, and use 'default' as a fall-back? But then,
how does one test for the presence of a given theme name in the system?
Suggestions would be warmly welcome to fix things at the distribution
level and avoid all the pain.

BTW, I find this kind of problems really annoying. How come upstream
Sphinx authors are breaking things like this? Just because of the rename
of the default sphinx theme from 'default' to 'classic'? That's really
not worth the amount of pain everyone will have. The person who did this
should be taking care of unbreaking all the things he broke. :(

Cheers,

Thomas Goirand (zigo)



More information about the OpenStack-dev mailing list