-
Notifications
You must be signed in to change notification settings - Fork 52
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 README.rst to Markdown #266
Comments
If you stick with RST you should change the header from:
to:
then pypi.org will render the README.rst correct |
Oh, I had been wondering about why that wasn’t working! Thank you for
catching that. If you’re interested in filing a PR for this I will merge
it, otherwise I’ll get to it when I deploy a new tiingo version this
weekend.
…On Tue, May 7, 2019 at 7:51 AM Feite Brekeveld ***@***.***> wrote:
If you stick with RST you should change the header from:
=============
Tiingo Python
=============
to:
Tiingo Python
=============
then pypi.org will render the README.rst correct
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#266 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ACE2MM7OOQXL7CUPFIP7NSLPUFUL5ANCNFSM4HK4ANHA>
.
|
Hi, pls. make the change yourself and bundle it with your deploy for the weekend. I'm not sure if these would break the rendering, but the specs say the length should be equal. Cheers |
Learned today that this can be linted using the readme_renderer, via |
RST is harder to work with and shrinking in usage. If we can confirm that markdown works well for the pieces that depend on it (sphinx docs, Python Package warehouse), the project documentation will be easier to maintain. It will also make adhering to projects like the
all-contributors
specification easier.https://github.com/all-contributors/all-contributors
The text was updated successfully, but these errors were encountered: