Explicitly classify readme.md as markdown in pyproject.toml for pypi

urbanopt / urbanopt-ditto-reader

Enhancement of URBANopt GeoJSON that can be consumed by DiTTo reader

Other

0 stars 1 forks source link

Explicitly classify readme.md as markdown in pyproject.toml for pypi #54

Closed vtnate closed 9 months ago

vtnate commented 9 months ago

SetupTools needs to be told that readme.md file is markdown, otherwise it defaults to declaring readme's as rst. This makes PyPI parse the file incorrectly and it will refuse a release push. Infinite sadness.

I suffered a lot with this in https://github.com/NREL/ThermalNetwork/pull/10 before coming to this solution.