Clean up README - Githubissues

sphinx-doc / sphinx-doc-translations

translated docs for sphinx official document

Other

21 stars 16 forks source link

Clean up README #21

Closed jdillard closed 9 months ago

jdillard commented 9 months ago

It looked like parts of the README were outdated, so thought I would try an spruce it up. I'm sure it could use some more work, but hopefully this PR puts it in a better place.

Summary of changes

Remove travis-ci badge
Remove "How to add a new version" section
Clean up "How to add a new language" section
Add Read The Docs badges
General wording improvements
Convert URLs to table
Convert README.md to README.rst

Preview

README.rst

AA-Turner commented 9 months ago

Can we make this .rst? That'd enable using .. list-table::

jdillard commented 9 months ago

Done! I was missing using the list-table syntax while making that in markdown.