Convert README format to reStructuredText #237
Merged
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
We had some problems with the anchor links in our README since PyPI does not support them when the format is markdown. However, they work fine with the reStructuredText format. Therefore, README is converted to that format. The conversion is mostly done using the `pandoc`. After the automatic conversion, some problems are fixed manually.
mdumandag
force-pushed
the
rest-readme
branch
from
547d2e5 to
737e90c
Compare
puzpuzpuz
approved these changes
Nov 9, 2020
puzpuzpuz
left a comment
puzpuzpuz
left a comment
There was a problem hiding this comment.
LGTM with some minor comments. I was mainly looking for any issues in the rendered html representation of the new readme.
Use 4 spaces for code samples, and 1 space after list elements.
Contributor
Author
|
Thanks a lot for the review, Andrey |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We had some problems with the anchor links in our README since
PyPI does not support them when the format is markdown. However,
they work fine with the reStructuredText format. Therefore, README
is converted to that format.
The conversion is mostly done using the
pandoc. After theautomatic conversion, some problems are fixed manually.