Skip to content

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

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb331ec
Use latest versions of sphinx and sphinx-rtd-theme
humitos Apr 19, 2017
3673681
Fix package name for conda
humitos Apr 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions readthedocs/doc_builder/python_environments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def install_core_requirements(self):
'pillow==2.6.1',
('git+https://github.com/rtfd/readthedocs-sphinx-ext.git'
'@0.6-alpha#egg=readthedocs-sphinx-ext'),
'sphinx-rtd-theme<0.3',
'sphinx_rtd_theme<0.3',
'alabaster>=0.7,<0.8,!=0.7.5',
'commonmark==0.5.4',
'recommonmark==0.4.0',
Expand Down Expand Up @@ -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.

'Pygments==2.2.0',
'docutils==0.12',
'docutils==0.13.1',
'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

'alabaster>=0.7,<0.8,!=0.7.5',
]

Expand Down