catalpa-cl / inceptalytics

An easy-to-use API for analyzing INCEpTION annotation projects.
16 stars 7 forks source link

Switch to poetry and add Sphinx autodocs. #26

Closed simulacrum6 closed 12 months ago

simulacrum6 commented 1 year ago

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:

# install poetry
curl -sSL https://install.python-poetry.org | python3 -

# install requirements
poetry install

# build documentation
poetry run sphinx-build docs _build

Related Issues Closes #8.