-
Notifications
You must be signed in to change notification settings - Fork 12
gh-433: use fancy-pypi-readme to do PyPI README prep
#929
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
Conversation
| [tool.hatch.metadata.hooks.fancy-pypi-readme] | ||
| content-type = "text/markdown" |
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.
Sadly, this doesn't seem to work if I put it in [tool.hatch] as metadata.hooks.fancy-pypi-readme.content-type = "text/markdown".
| overrides."tool.hatch".first = [ | ||
| "build", | ||
| "version", | ||
| ] |
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.
This is frustrating, something to do with TOML array of tables. Same thing discussed in pappasam/toml-sort#94.
Description
This PR uses the
fancy-pypi-readmepackage to do thestablereplacement in documentation links on PyPI. I have tested this locally and the generatedMETADATAfile follows the desired format. This allows us to simplify the README format.I've also made the link format more consistent in the README.
I also did aworkflow_dispatch, the logs appear to have worked. The TestPyPI action has failed, needs some config on your end @ntessore?logs_52895020779.zip
Closes: #433
Checks