convert changes to markdown #391
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Also added a 0.20.0 section. Pallets policy is to include a change entry with each PR that needs it. It means the release process is not blocked on a maintainer going through and collecting a bunch of entries from the commit log before release. And the docs will list the changes for the upcoming release. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Convert changes from reStructuredText to Markdown. This is part of a project that I am working on to automate release message generation. Having the changes in markdown makes it easier to copy into GitHub's editor.
This was a mix of automated and manual conversion. The
rst2mystcommand can do the initial conversion, but then I went through and fixed missing code formatting, rewrapped some lines, fixed some grammar and spelling, etc. I also converted the section header format to be "Version A.B.C" with "Released YYYY-MM-DD" on its own line. This allows Sphinx to generate much nicer/predictable anchors for each section, and matches the Pallets style.