pin sphinx version becuase of sphinx bug in 3.2.0#238
Merged
chinmayshah99 merged 2 commits intoOpenMined:devfrom Aug 12, 2020
Merged
pin sphinx version becuase of sphinx bug in 3.2.0#238chinmayshah99 merged 2 commits intoOpenMined:devfrom
chinmayshah99 merged 2 commits intoOpenMined:devfrom
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
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
Because of this bug, sphinx-doc/sphinx#8074, we can't use sphinx 3.2.0 to build docs for latest PyDP with docstrings. It results in
To reproduce - inside PyDP (dev branch) and in a clean virtual environment, run:
Thus without restricting the version of Sphinx, in docs/requirements.txt we run the risk of install 3.2.0 and therefore building the docs will fail. Thus the fix in this PR restricts the version of Sphinx in docs/requirements.txt to be no greater than 3.1.2.
Affected Dependencies
Sphinx
How has this been tested?
In a new python environment with only the python-dp in the current dev branch installed, running:
succesfully builds the docs.
Checklist