[ENHANCEMENT] Automatic documentation generation

[linguini1]

Problem

Although the repository currently has a good amount of inline documentation, it is only visible in the source code.

Proposed Solution

There should be a static webpage that hosts the documentation, which is automatically generated by a GitHub workflow. In order to do this, there should also be a standard doc-string format enforced (one that integrates well with Python tools & LSPs).

Additional Context

There are a couple different doc-string formats (list non-exhaustive):

• Sphinx
• Google
• reST

Ideally, the format that is selected should be able to have a description, parameters, return description, exceptions which could be raised and example usages. Exceptions and examples should be optional fields.

Additionally, the documentation generator should automatically pick up on the type annotations to be included in the documentation. This will avoid duplicating type information in doc strings, which is prone to mistakes. This generator should also pick up default values for keyword arguments.