Skip to content

improve Documentation #62

@Deric-W

Description

@Deric-W

Problem:
The current documentation consists of the README and docstrings, which contain only limited amounts of information.
Furthermore, it is laborious to look in the source code for documentation.

Solution:
Use documentation generators like Sphinx to generate documentation from docstrings and annotations and host them on Read the Docs.

Further ideas:
All classes should have a custom __repr__ method to improve interactive debugging.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions