convert readme from rst to md #119
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
There was a problem hiding this comment.
Pull Request Overview
This PR converts the project's documentation from reStructuredText to Markdown for more consistent support on PyPI. Key changes include:
- Updating file references in pyproject.toml to point to Markdown files.
- Removing the README.rst and AUTHORS.rst files.
- Introducing new Markdown documentation in README.md and AUTHORS.md.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated the readme and author file references. |
| README.rst | Removed the old reStructuredText readme. |
| README.md | Added a new Markdown readme with equivalent content. |
| AUTHORS.rst | Removed the old reStructuredText authors file. |
| AUTHORS.md | Added a new Markdown authors file. |
Collaborator
Author
|
Great job! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
rst is not well supported by pypi (and not as standard as markdown).