Improve and Host Documentation

[kkiani]

Description:

We need to enhance and formalize the project's documentation. This includes:

Tasks:

• Improve existing docstrings across the codebase for better clarity and consistency.
• Enforce docstring standards using ruff for automatic checks.
• Investigate using MKDocs for generating user-friendly documentation.
• Set up automatic documentation generation as part of the CI pipeline.
• Host the generated documentation on a dedicated domain for easy access.

Acceptance Criteria:

• All public methods and functions have clear, well-written docstrings.
• ruff configured to enforce docstring standards during CI.
• Documentation hosted on a domain, and automatically updated via CI.
• MKDocs evaluated and integrated if feasible for long-term use.

[kkiani]

This tutorial from Real Python can be a good start for implementation and discoloration: https://realpython.com/python-project-documentation-with-mkdocs/