Skip to content
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

Use latest versions of sphinx and sphinx-rtd-theme #2802

Closed

Conversation

humitos
Copy link
Member

@humitos humitos commented Apr 19, 2017

I upgraded the conda pinned versions as in pip environments.

Again, we should consider to remove all of this pinned versions (#2566 (comment)). In the meantime, I upgraded them.

This need testing with a project that uses this.

Closes #2714
Closes #2584

@humitos humitos added the PR: work in progress Pull request is not ready for full review label Apr 19, 2017
@humitos humitos added PR: ready for review and removed PR: work in progress Pull request is not ready for full review labels Apr 19, 2017
@ericholscher
Copy link
Member

Does conda have the proper packages now? We could always setup a conda-test repo if we wanted, in order to control it ourselves.

'mock',
'pillow>=3.0.0',
'sphinx_rtd_theme==0.1.7',
'sphinx-rtd-theme<0.3',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One of these is underscore, the other is dashes. We should be consistent.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latter is more consistent because _ is replaced by -: http://stackoverflow.com/questions/19097057/pip-e-no-magic-underscore-to-dash-replacement

@@ -193,12 +193,12 @@ def install_core_requirements(self):

# Use conda for requirements it packages
requirements = [
'sphinx==1.3.5',
'sphinx==1.5.3',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we do sphinx<1.6 on both?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be nicer to pin Sphinx because it's so vital that bumping the version should be challenged every time by a deliberate action (PR) ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@benjaoming Given the frequent release cycle for Sphinx, semver, as well as the workload on the core team here, I concur with @ericholscher's recommendation to float up to the next major release. Moving to support Sphinx 1.6 would be a deliberate action.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@willingc good point, and actually looking at a search result on the Sphinx issue tracker reveals that their 1.5 series does not seem to carry many issues specific to patch versions, so it's low risk.

This issue in Sphinx 1.5.2 might be an example of how RTD would have to skip a patch release due to an issue, however that could be fixed reactively when necessary.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also +1 on <1.6 here. The Sphinx devs are very deliberate with versioning these days, I trust that bugfix versions won't have a strong effect here. Additionally, the number of issues we've had from indescriminately selecting versions are outweighted by the number of bugfixes we haven't adopted.

@humitos
Copy link
Member Author

humitos commented May 15, 2017

@agjohnson @ericholscher I'm marking this as Sprintable so we don't forget to discuss during these couple of days that we are going to be together. I think it's a good moment to take a decision on which direction to take (to pin or not pin, that's the question).

@humitos
Copy link
Member Author

humitos commented May 23, 2017

I'm closing this one because of #2876, where we discuss at PyCon Sprint about this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sprintable Small enough to sprint on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants