You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A lot of python packages use sphinx for documentation, and many of those incorporate the README into the docs page; so many packagers of python projects prefer RST format for the readme. Indeed, the default readme content type for PyPI is RST. Maturin is currently angled more towards rust packages, and so expects a markdown readme, even though it publishes packages to pypi. As such, the long descriptions on pypi are messed up.
Is there any way around this?
The text was updated successfully, but these errors were encountered:
Markdown is hard-coded as content-type here. regarding an implementation i wonder whether that field should be mandatory when a description is given, or whether maturin should try to sniff it. i also have doubts whether GFM (or any other) should be the default dialect.
It would be most familiar if it behaved the same as setuptools (assume rst) but realistically the current behaviour should probably remain the default. Markdown flavour could easily be configurable, again defaulting to current behaviour.
A lot of python packages use sphinx for documentation, and many of those incorporate the README into the docs page; so many packagers of python projects prefer RST format for the readme. Indeed, the default readme content type for PyPI is RST. Maturin is currently angled more towards rust packages, and so expects a markdown readme, even though it publishes packages to pypi. As such, the long descriptions on pypi are messed up.
Is there any way around this?
The text was updated successfully, but these errors were encountered: