From d60b95f0212a6188848c096a5ba0538514f8bfd8 Mon Sep 17 00:00:00 2001 From: Roman Kalyakin Date: Sun, 8 Dec 2024 19:40:04 +0800 Subject: [PATCH] Added gh-pages --- .github/workflows/python-publish.yml | 2 ++ README.md | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index 1e0f0c3..3f79376 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -43,3 +43,5 @@ jobs: with: user: __token__ password: ${{ secrets.PYPI_TOKEN }} + - name: Publish docs + run: mkdocs gh-deploy diff --git a/README.md b/README.md index cbe787b..d96dbd5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,10 @@ [![PyPI version](https://badge.fury.io/py/impresso.svg)](https://badge.fury.io/py/impresso) ![PyPI - License](https://img.shields.io/pypi/l/impresso) -Impresso is a library to interact with the [Impresso](https://impresso-project.ch/app) dataset. It provides a set of classes to interact with the API and a set of tools that make working with the data easier. + +Impresso is a library designed to facilitate interaction with the [Impresso](https://impresso-project.ch/app) dataset. It offers a comprehensive set of classes for API interaction and a variety of tools to streamline data manipulation and analysis. + +You can find the full documentation at [https://impresso.github.io/impresso-py/](https://impresso.github.io/impresso-py/). ## Installation