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.

Sign up for GitHub

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

Jump to bottom

RST-Readme rendering broken on Github #121

Closed

adbar opened this issue Apr 16, 2024 · 0 comments · Fixed by #123

Owner

adbar commented Apr 16, 2024

I witness this bug in my other projects as well: RST files are currently improperly rendered on Github.

Proposed change: switch the Readme to markdown (e.g. using pandoc) as this format is supported by Github and Pypi alike.

adbar changed the title ~~Readme redering broken on Github~~ RST-Readme rendering broken on Github

adbar linked a pull request

that will close this issue

docs: switch README to markdown and update #123

Merged

2 tasks

adbar closed this as completed in #123

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment