Convert CHANGELOG and CONTRIBUTING from .rst to .md - #277
hugovk merged 3 commits into
Conversation
Sorry, something went wrong.
StanFromIreland
left a comment
There was a problem hiding this comment.
One minor fix and then LGTM. I could find no other faults, and the GitHub render looks fine too.
Sorry, something went wrong.
|
I think to an extent this is churn, and I do disagree with the premise. I would suggest that a consistency of markup formats within the project matters more than copying-and-pasting into a third party tool (IIRC, GitHub copes with pasting in the rendered HTML, though one has less control). This seems to be a loosing battle though, and README files have been changed to markdown for various reasons elsewhere, so I won't block this if there's desire to push ahead. A |
Sorry, something went wrong.
Markdown is easier to work with, these files are not used by Sphinx, and this will make it easier to copy and paste the generated changelog from GitHub into the file (and avoid mistakes like #276 (comment)).
📚 Documentation preview 📚: https://python-docs-theme-previews--277.org.readthedocs.build/