-
Notifications
You must be signed in to change notification settings - Fork 308
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.
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
Reorder installation in .readthedocs.yaml #825
Conversation
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.
8d86c52
to
bf87b81
Compare
With some help from @webknjaz on IRC, I found a nicer solution of simply reordering the installation commands in |
install: | ||
- requirements: docs/requirements.txt | ||
- method: pip | ||
path: . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd also add a comment about twine
having docutils
among the transitive deps.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for figuring this out. I've made a suggestion to clarify the comment.
RTD installs this project with
pip install -U --upgrade-strategy eager .
which pulls in docutils via
readme_renderer
. Pinningdocutils
eventhough we don't directly depend on it clears up the rendering errors.