Reformat the README #10513
Merged
Reformat the README #10513
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
Closed
Co-authored-by: Takeshi KOMIYA <[email protected]>
Member
|
Merged! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
I noticed that README.rst was out of date (mentioning Travis/AppVeyor etc), so I went through and reformatted / simplified -- I took a bit of inspiration from https://github.com/executablebooks/MyST-Parser/blob/master/README.md, but not a carbon copy.
Feature or Bugfix
Purpose
Comparison:
Sphinx
5.xThis branch
A