search

kylebgorman / pynini

Read-only mirror of Pynini
http://pynini.opengrm.org
Apache License 2.0
120 stars 26 forks source link

Refactor docs #2

Closed erip closed 6 years ago

erip commented 6 years ago

This PR unifies the docs and adds extensions for automatic rendering in GitHub.

kylebgorman commented 6 years ago

I'm not sure if this matters anymore (maybe this should just work on GitHub and that's fine) but I think I went with .rst only because PyPi only supports it (and not Markdown). Does anybody care about the docs being rendered in HTML on PyPi?

erip commented 6 years ago

Ah, yes. FWIW, the conversion is simple enough, but perhaps needless. I can make the README an rst instead since GitHub can render either.

kylebgorman commented 6 years ago

Yeah, let's do that instead!

One last small request: for context, can you rewrite the sentence from the old README.md to read something like:

"Note that the GitHub repository is a (primarily read-only) mirror to enable bug reports and outside contributions."

On Fri, Mar 16, 2018 at 3:48 PM, Elijah Rippeth notifications@github.com wrote:

Ah, yes. FWIW, the conversion is simple enough, but perhaps needless. I can make the README an rst instead since GitHub can render either.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/kylebgorman/Pynini/pull/2#issuecomment-373825819, or mute the thread https://github.com/notifications/unsubscribe-auth/AAJuOYjxmtWot1nVDhpL3tamGlzgHRZ7ks5tfBcngaJpZM4SuVP4 .

erip commented 6 years ago

It's here. I had just moved it up into the main block.

erip commented 6 years ago

Eep, don't merge yet... rst isn't rendering quite correctly...

erip commented 6 years ago

OK, at last... I've made the changes so rst can render. What a silly markup. :-)