Skip to content

Generate API documentation #15

@negz

Description

@negz

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 documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions