Commit graph

3 commits

Author SHA1 Message Date
Toshio Kuratomi
48a4b00ade When I rebased the README as rst PR, I missed a few changes.
(cherry picked from commit 98a6827be0)
2018-04-11 13:26:41 -07:00
Sviatoslav Sydorenko
9fd122d7be Add docs badge to README
(cherry picked from commit 2a55c64da9)
2018-04-11 11:58:09 -07:00
Stephen Weber
28651a85ab Convert README from Markdown to ReStructured Text and use as longdesc (#22330)
* Convert README from Markdown to ReStructured Text and use as longdesc

Discussion in #13758 led to deciding to switch README to rst and having
setup.py consume it as the long_description.

* Fix long string in setup.py for pep8 compliance

* Open README.rst as read-only

* Update usages of root README.md to README.rst

Unsure about the file ./packaging/debian/docs as it (only) contains the
text README.md. I believe it's referencing ./packaging/debian/README.md
but maybe someone who knows debian packaging could review it?

* Pick up fixes that had been merged into README.md after the initial conversion to rst

(cherry picked from commit 7afa34ae8a)
2018-04-11 11:57:24 -07:00