Skip to content

API documentation #101

@robin-snt

Description

@robin-snt

Please create a sphinx generated API definition.

The readme and examples are not sufficient to understand how this client works. It would be extremely helpful if there at least an API overview, where the classes and functions were clearly defined in terms of input and output. E.g: https://2.python-requests.org/en/master/api/#main-interface

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/documentationDocumentation related issues.kind/enhancementSomething could be better.status/acceptedWe were able to reproduce the issue and accept to work on it.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions