DOC: Fix tools and release notes to be more markdown compatible. #8424
Conversation
This file contains hidden or 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
The release notes are rst, but they can be made more markdown compatible to improve their appearance when posted on github for the releases. It is not possible to achieve full compatibility, so pavement.py is also changed so that two versions of the README file are generated by the write_release_and_log command, a signed version that can be uploaded as a binary file, and an md version whose content can be cut and pasted into the release documentation window on github. The changes consist of the following * Use `*` for marking lists rather than `-`. * Use `-` strings for underlining H2 headings. * Indent file hashes so that they are rendered as code. * Change link notation in the posting version * Do not sign the posting version. [ci skip]
|
This is against the |
|
LGTM, merged. |
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.
The release notes are rst, but they can be made more markdown compatible
to improve their appearance when posted on github for the releases. It
is not possible to achieve full compatibility, so pavement.py is also
changed so that two versions of the README file are generated by the
write_release_and_log command, a signed version that can be uploaded as
a binary file, and an md version whose content can be cut and pasted
into the release documentation window on github. The changes consist of
the following
*for marking lists rather than-.-strings for underlining H2 headings.[ci skip]