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.

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

Update default sphinx version #4250

Merged
merged 4 commits into from
Jun 19, 2018
Merged

Update default sphinx version #4250

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1dd1910
Update default sphinx version
stsewd Jun 15, 2018
5fd8abc
Pin sphinx to <1.8
stsewd Jun 18, 2018
92513d5
Refactor tests
stsewd Jun 18, 2018
f9afaf0
Unpin requirements in tests
stsewd Jun 18, 2018
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
2 changes: 1 addition & 1 deletion readthedocs/doc_builder/python_environments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ def install_core_requirements(self):
self.project.get_feature_value(
Feature.USE_SPHINX_LATEST,
positive='sphinx<2',
negative='sphinx==1.7.5',
negative='sphinx<1.8',
),
'sphinx-rtd-theme<0.5',
'readthedocs-sphinx-ext<0.6'
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/rtd_tests/tests/test_doc_building.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,7 +1152,7 @@ def test_install_core_requirements_sphinx(self):
requirements_sphinx = [
'commonmark==0.5.4',
'recommonmark==0.4.0',
'sphinx==1.7.5',
'sphinx<1.8',
Copy link
Member

Choose a reason for hiding this comment

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

Feels like we shouldn't be checking for this in a test, as it makes it really brittle. Should we remove this test?

Copy link
Member

Choose a reason for hiding this comment

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

Looking at it more, it looks like we should be checking for what we actually care about (eg. 'sphinx' in called_arguments not "check it called the exact versions from our code"

Copy link
Member Author

Choose a reason for hiding this comment

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

That makes sense, should I change all the tests here?

Copy link
Member

Choose a reason for hiding this comment

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

Sure. I think it's a small enough change to be fine.

'sphinx-rtd-theme<0.5',
'readthedocs-sphinx-ext<0.6',
]
Expand Down