This PR introduces Poetry for dependency management and adds autodocs with Sphinx.
The documentation is hosted via Github Pages and a Github Action has been set up to generate documentation files upon publication of a new release. The documentation is quite barebones at the moment and should be extended with better descriptions and more examples in the future.
NOTE: Due to dependency requirements the project is only compatible with Python 3.9 and Python 3.10 at the moment.
Description
This PR introduces Poetry for dependency management and adds autodocs with Sphinx.
The documentation is hosted via Github Pages and a Github Action has been set up to generate documentation files upon publication of a new release. The documentation is quite barebones at the moment and should be extended with better descriptions and more examples in the future.
NOTE: Due to dependency requirements the project is only compatible with Python 3.9 and Python 3.10 at the moment.
Testing
Run the following commands on your terminal:
Related Issues Closes #8.