Publish documentation on Read The Docs about dnaio

[marcelm]

Switching from ReST to Markdown is possible by using
https://www.mkdocs.org/ + https://mkdocstrings.github.io/ or mkautodoc or MkAPI

If we use ReST, I probably prefer Google-style docstrings

[rhpvorderman]

I prefer ReST over markdown. I use ReST wherever I can. Markdown is simpler for tables, but that is about it. YMMV.

Anyway, google style looks good! A good docstring style does not use stuff like :param: because that shows up when the user types help(func) on the REPL as well. If it looks good on the REPL and sphinx can turn it into something nicely looking then it is fine with me.

Decide whether to use the RTD page as homepage URL

In my opinion the github page is better for this, as it also contains the issue tracker as well as a README with all the information one needs. Ideally the library is so pythonic that people can get away with not reading the documentation. (At least that is something to strive for ;-) ).

[marcelm]

It seems there’s a trend of moving away from ReST, which is why I brought this up. I don’t like a couple of things about ReST (mainly that I constantly have to lookup how to write certain constructs), so in a way I agree, but it also has some advantages over Markdown. I’ve gotten used it now, so let’s stick with ReST.

[marcelm]

I have now linked the documentation from the GitHub project and page and from within the README.