Documentation v0.3.0

[enryH]

• Datenguide Python version: 0.3.0
• Python version:
• Operating System:

Description

Thread for comments on Documentation.

[enryH]

Loading the README.rst leads to having the link to the documentation on top while one is on the documentation. Should we have a copy of the README just in the docs folder?

[enryH]

Should we add a picture to the minimal example of the resulting DataFrame? Or even an embedded HTML version?

[enryH]

there could be a button to launch the quick-start example or maybe some output added?

[KonradUdoHannes]

I have a little bit of output in the pitfall section which I'm working on. I first had a complete output example but that generates a table which his a little too large, due to the source default fields. Cutting of the source fields makes the tables small enough to display but would already make the example a little more than minimal.
I'm not sure what the best approach is, but maybe interactive examples would be better suited for binder. Currently Binder is not referenced in the documentation because we did not have it when the docs where setup.