Reorder installation in .readthedocs.yaml #825
Merged
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
When RTD installs `.`, it uses `--upgrade-strategy eager`. If this is done after installing from `docs/requirements.txt`, packages may be upgraded that shouldn't be; currently, `docutils` gets upgraded to 0.18, which current versions of `Sphinx` can't work with.
zware
force-pushed
the
fix_readthedocs_rendering
branch
from
8d86c52 to
bf87b81
Compare
zware
changed the title
Contributor
Author
|
With some help from @webknjaz on IRC, I found a nicer solution of simply reordering the installation commands in |
webknjaz
reviewed
Nov 2, 2021
| install: | ||
| - requirements: docs/requirements.txt | ||
| - method: pip | ||
| path: . |
Member
There was a problem hiding this comment.
I'd also add a comment about twine having docutils among the transitive deps.
bhrutledge
requested changes
Nov 3, 2021
Contributor
bhrutledge
left a comment
bhrutledge
left a comment
There was a problem hiding this comment.
Thanks for figuring this out. I've made a suggestion to clarify the comment.
bhrutledge
approved these changes
Nov 3, 2021
webknjaz
approved these changes
Nov 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
RTD installs this project with
pip install -U --upgrade-strategy eager .which pulls in docutils via
readme_renderer. Pinningdocutilseventhough we don't directly depend on it clears up the rendering errors.