New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump sphinx default version to 1.7.4 #4035

merged 2 commits into from Apr 30, 2018


None yet
2 participants

humitos commented Apr 27, 2018

Since the feature flag is sphinx<2, I didn't touch it.

Closes #4015

@humitos humitos requested a review from rtfd/core Apr 27, 2018


This comment has been minimized.


humitos commented Apr 27, 2018

I'm not sure how we handle this usually.

This is a big change that shouldn't produce builds without a pinned version to break but it could happen. I think it's good to have our main dependencies pinned to the latest versions, though.

Maybe, depending on how many projects break, we can tell the users to pin to their latest working sphinx version (1.6.5) or revert this PR.

@agjohnson agjohnson added this to the 2.4 milestone Apr 27, 2018


This comment has been minimized.


agjohnson commented Apr 27, 2018

The feature flag exists so we can monitor this at least a little bit. The first step is to see if projects with the feature flag (should already be using Sphinx 1.7 unless there is an override) are noticing higher than average build failures (compared to projects without the flag). This isn't perfect though. Next step would probably be verifying that projects with the feature flag build normally, are built with Sphinx 1.7, and are displayed correctly.

Perhaps some form of prod QA testing automation could help us here, like a QA test suite that hits the prod database to query for some of this in an automated way. Perhaps something we us to verify deploys? I'm just spitballing here though. We can test this manually for now.


This should be fine, assuming we have tested for 1.7 compat by querying the feature flagged projects.


This comment has been minimized.


humitos commented Apr 30, 2018

I checked out those numbers and the success build ratio seems improved when using the latest sphinx version.

Also, I did some manual test for a couple of projects in production (channels, astropy-tutorials, picongpu) and they seem to be rendering properly.

@humitos humitos merged commit 43e82b0 into master Apr 30, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed

@humitos humitos deleted the humitos/sphinx/bump branch Apr 30, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment