README extension wrong in `setup.cfg`

mphowardlab / relentless

Computational materials design, with less code.

https://relentless.readthedocs.io

BSD 3-Clause "New" or "Revised" License

10 stars 1 forks source link

README extension wrong in `setup.cfg` #248

Closed mphoward closed 3 months ago

mphoward commented 7 months ago

This line refers to the wrong README file extension:

https://github.com/mphowardlab/relentless/blob/dacdb02c34fc84a2aba7c9b9efc7f576b4d6bfc6/setup.cfg#L22

That is causing issues on PyPI documentation and was caught as an issue setting up a build on conda-forge.

It should either changed to README.rst or the README file extension should be changed to .md.

mphoward commented 4 months ago

This file still shows up terribly on PyPI even though it's linked in right, so we should try converting to Markdown. This may complicate its inclusion in the sphinx documentation a bit.

mphoward commented 3 months ago

Fixed in #254