-
Notifications
You must be signed in to change notification settings - Fork 12
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
What problem are you facing?
We're using type annotations and Google-style pydoc strings for all modules, classes, functions, etc in this SDK. Currently there's no API reference though - the only way to find out what this SDK can do is to read the code.
How could this Function help solve your problem?
We should generate API documentation and host it somewhere. https://wiki.python.org/moin/DocumentationTools has a list of tools that do this. Ideally we'd have something pretty lightweight. I have a slight preference for generating markdown as opposed to having to generate a website (and presumably host it somehow - using GitHub Pages?).
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request