Allow the readme to be included implicitly #99
Merged
Conversation
This file contains 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
I'm hoping that this will get PyPI to use the README data from the metadata rather than from the README.md, which will mean it will pick up that it's markdown and so (hopefully) render it correctly. The README files still get included in the sdist, so at worst I think this removes a redundant mention of it in the MANIFEST.in. The plugins have READMEs in reStructuredText anyway, so the mention of a README.md in their MANIFEST.in was likely causing weirdness anyway.
This reverts commit 8aa793d.
While this means that the lint & typechecking jobs are isntalling a bit more than they need, the consistency and simplicity of keeping them in step feels worth it.
alexivanov
approved these changes
Jan 8, 2021
|
This didn't work as I missed the way that some of the requirements are specified. b4afed9 aims to fix that. |
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.
I'm hoping that this will get PyPI to use the README data from the metadata rather than from the
README.md, which will mean it will pick up that it's markdown and so (hopefully) render it correctly.The README files still get included in the sdist, so at worst I think this removes a redundant mention of it in the
MANIFEST.in.The plugins have READMEs in reStructuredText anyway, so the mention of a
README.mdin theirMANIFEST.inwas likely causing weirdness anyway.