Documentation - Suggestions

[lukaspanni]

I started to work on the documentation (see #41) and I have a few suggestions:

• Include source-code documentation into sphinx
• Provide the documentation in both german and english
• Rethink the README - currently it is a mix of quickstart, documentation for specific apis and links to more documentation on autogenerated api-clients; IMO it should only contain a short description of the repo, how to install it and where to find more documentation
• Provide an Issue template for documentation related issues and tag them as documentation, which would make it easier to plan and track documentation progress and allow to filter bugs and other issues.
• Host the documentation on readthedocs (@LilithWittmann thats something you should look into)

[LilithWittmann]

@lukaspanni should be now building to https://deutschland.readthedocs.io/en/latest/.

[lukaspanni]

Great!
However, I get a 404. It's probably only a configuration error.

[eUgEntOptIc44]

@LilithWittmann same here.

[lukaspanni]

Just saw this issue again, still not working ...
Maybe @LilithWittmann can fix this.

[rgerhards]

still not working today ;-)