-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
This ticket combines several tasks that are needed to create the first version of user-friendly documentation:
- Move documentation from current sphinx format to Material for MkDocs (includes re-formatting docstrings)
- Add a useful README page, should have description, installation instructions + some quick examples
- Use mkdocstrings for API reference
- Start off with some useful examples/guides for general documentation
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation