Add project documentation

.github/workflows/code_coverage.yml → .github/workflows/ci.yml

@@ -1,5 +1,5 @@
 ---
-name: Code Coverage
+name: Continuous Integration
 
 on:
   push:
@@ -11,7 +11,7 @@ on:
 
 jobs:
   test:
-    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    name: Code Coverage (Python ${{ matrix.python-version }} on ${{ matrix.os }})
     runs-on: ${{ matrix.os }}-latest
     strategy:
       matrix:
@@ -40,3 +40,27 @@ jobs:
           file: ./coverage.xml
           flags: unittests
           name: codecov-umbrella
+  docs:
+    name: Generate and Upload Documentation
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+    - name: Checking out code from GitHub
+      uses: actions/[email protected]
+    - name: Set up Python 3.9
+      uses: actions/[email protected]
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip pdoc3
+        pip install -r requirements.txt
+        pip list
+    - name: Generate documentation
+      run: pdoc --html sharkiq
+    - name: Deploy Documentation
+      if: github.event_name == 'push'
+      uses: JamesIves/[email protected]
+      with:
+        branch: docs
+        folder: html/sharkiq

.gitignore

@@ -134,4 +134,7 @@ dmypy.json
 
 # Secrets
 secrets.py
-driver.py
+driver.py
+
+# Documentation
+html/

sharkiq/__init__.py

@@ -1,4 +1,4 @@
-"""Python API for Shark IQ vacuum robots"""
+"""Unofficial SDK for Shark IQ robot vacuums, designed primarily to support an integration for Home Assistant."""
 
 from .ayla_api import get_ayla_api, AylaApi
 from .exc import (