Skip to content
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

Merged
merged 2 commits into from
Nov 3, 2021

Conversation

zware
Copy link
Contributor

@zware zware commented Nov 2, 2021

RTD installs this project with pip install -U --upgrade-strategy eager .
which pulls in docutils via readme_renderer. Pinning docutils even
though we don't directly depend on it clears up the rendering errors.

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 zware changed the title Pin docutils < 0.18 to fix readthedocs rendering Reorder installation in .readthedocs.yaml Nov 2, 2021
@zware
Copy link
Contributor Author

zware commented Nov 2, 2021

With some help from @webknjaz on IRC, I found a nicer solution of simply reordering the installation commands in .readthedocs.yaml and have pushed that change here instead.

@zware zware mentioned this pull request Nov 2, 2021
@bhrutledge bhrutledge self-requested a review November 2, 2021 20:27
install:
- requirements: docs/requirements.txt
- method: pip
path: .
Copy link
Member

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.

Copy link
Contributor

@bhrutledge bhrutledge left a 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.

.readthedocs.yaml Outdated Show resolved Hide resolved
@bhrutledge bhrutledge merged commit f0fc7e8 into pypa:main Nov 3, 2021
@zware zware deleted the fix_readthedocs_rendering branch November 3, 2021 03:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants