Pin Sphinx to 1.x #13805
Merged
Pin Sphinx to 1.x #13805
Conversation
This file contains hidden or 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
ImportanceOfBeingErnest
approved these changes
Mar 30, 2019
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon! If these instruction are inaccurate, feel free to suggest an improvement. |
tacaswell
added a commit
to tacaswell/matplotlib
that referenced
this pull request
Mar 31, 2019
BLD: Pin Sphinx to 1.x
Conflicts:
requirements/doc/doc-requirements.txt
- the v3.1 branch support sphinx < 1.8 and carries a bunch
of known-bad version exclusions
timhoffm
added a commit
that referenced
this pull request
Mar 31, 2019
…-v3.1.x Merge pull request #13805 from timhoffm/pin-sphinx-1.x
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.
PR Summary
As reported in #13591 the matplotlib style is not rendered correctly with sphinx 2.0.
See also e.g. https://matplotlib.org/devdocs/api/axes_api.html.
As a temporary containment (and in the prospect that 3.1 might be released soon), this pins sphinx to <2.0 to keep the docs correctly rendered.
In the long run, we need to adapt the matplotlib style.