Fixes Sphinx version for docs to 1.3b1 #1700
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The docs test is currently broken because it's incompatible with the latest version of Sphinx. By fixing Sphinx to an exact version number, we avoid picking up a newer version that breaks everything.
|
By analyzing the blame information on this pull request, we identified @gpoulin, @Tarrasch and @themalkolm to be potential reviewers |
The latest version of sphinx has a different signature for warn_node than the one we were using in our overridden version. By adding *args and **kwargs we now have a more future-proof version of this override.
Current coverage is 76.10%@@ master #1700 diff @@
==========================================
Files 94 94
Lines 10285 10285
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
- Hits 8104 7827 -277
- Misses 2181 2458 +277
Partials 0 0
|
|
Thanks. Though I don't understand why you didn't bump the version to today's most recent. |
|
I haven't worked on the documentation much, so I didn't want to be responsible for changing how it's generated. If you want that version, go for it. |
|
Sure. Your defensiveness here makes sense. Again thanks for the PR. :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes Sphinx requirement for docs from
Sphinx>=1.3b1toSphinx==1.3b1and updates the sphinx warn_node override to better match the function signature in newer versions.Motivation and Context
The docs test is currently broken because it's incompatible with the latest version of Sphinx. By fixing Sphinx to an exact version number, we avoid picking up a newer version that breaks everything. By also fixing the bug that broke the newer version, we can use a newer version if we choose.
Have you tested this? If so, how?
I ran the doc test and it succeeded with the lower version with and without the bugfix and with the latest version with the bug fix.