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

Matthew Thode prometheanfire at gentoo.org
Fri May 29 14:49:26 UTC 2015


On 05/29/2015 07:56 AM, Thomas Goirand wrote:
> 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)
> 
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> 
We won't have a problem with with doc generation on Gentoo at least.
We've had 1.3.1 available for some time now (though not stablized yet,
even then it will not mater).  Are you not able to either create a
meta-package or package the two versions side by side (mutually
exclusive install of course)?

-- 
-- Matthew Thode (prometheanfire)

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 801 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150529/deb9d72f/attachment.pgp>


More information about the OpenStack-dev mailing list