README.rst isn't rendered properly

[Laszlo Szathmary]

README.rst isn't rendered properly. It should be in Markdown format.

[Julien Danjou]

Not rendered properly where?
It's in rst format 🤷

[Laszlo Szathmary]

In the browser: https://imgur.com/PzypWOE.png

Or is it supposed to look like this?

[Matthew D. Scholefield]

+1, I came here to check if the project was dead (malformed READMEs are usually a sign of that).

The problem appears to be that GitHub doesn't automatically select the language and doesn't parse the hide directives which lead it to outputting malformed code blocks.

@jd Would you be open to one of the following?:

1. Adding a separate short markdown readme (README.md) that gives the quick intro blurb and then links to the readthedocs documentation
2. Converting the test code blocks to blocks like .. code-block:: python within README.rst (which I presume would prevent sphinx from validating these as tests).