Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert docs from rst to md? #33

Closed
pauleveritt opened this issue Jul 2, 2023 · 2 comments
Closed

Convert docs from rst to md? #33

pauleveritt opened this issue Jul 2, 2023 · 2 comments

Comments

@pauleveritt
Copy link
Collaborator

I wanted the docs top page to share the content from the README. But it's README.md not README.rst.

I propose switching to MyST and Markdown for the stuff in docs. Obviously the PEP would remain in RST, but MyST supports RST/MD mixing.

@merwok
Copy link

merwok commented Jul 3, 2023

The readme is short, github supports rendering reST, what about converting to README.rst?

@pauleveritt
Copy link
Collaborator Author

As mentioned in #40 we are stripping down this repo. The tutorial is being worked on as part of a "site" that is on a different timing than the PEP, so closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants