feature/5/python-api-docs

[banagale]

Submit a pull request

CLA

• I have signed the Stream CLA (required).
• The code changes follow best practices
• Code changes are tested (add some information if not applicable)

Description of the pull request

This is an attempt to work toward fixing #5, where the actual python implementation lacks documentation.

This PR has a working example docs here: https://stream-chat-python-docs.readthedocs.io/en/latest/_sources/stream_chat.html#subpackages

This was my first time building for sphinx / rtd.

It is likely someone more familiar with sphinx api doc gen could make the landing page for the docs be simply the stream_chat package.

Edit:

Upon further review, it looks like this is not catching the actual module. I think a minor tweak would get this working.

[peterdeme]

I think for now, we'll stick to the official documentation. In the next few weeks/months we'll try to cover everything in https://getstream.io/chat/docs/python/?language=python