Merge pull request #22 from noahhusby/docs/pdoc

Add pdoc

.github/workflows/pages.yml

@@ -0,0 +1,48 @@
+---
+name: Deploy pdocs to Pages
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+  actions: read
+
+env:
+  PYTHON_VERSION: 3.11
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: 🏗 Set up Poetry
+        run: pipx install poetry
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: "poetry"
+      - name: 🏗 Install workflow dependencies
+        run: |
+          poetry config virtualenvs.create true
+          poetry config virtualenvs.in-project true
+      - name: 🏗 Install dependencies
+        run: poetry install --no-interaction --with docs
+      - run: pdoc ./aiostreammagic -o docs/
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

aiostreammagic/__init__.py

@@ -1,4 +1,6 @@
-"""Asynchronous Python client for StreamMagic API."""
+"""
+.. include:: ../README.md
+"""
 
 from .exceptions import StreamMagicError, StreamMagicConnectionError
 from .models import (

pyproject.toml

@@ -24,6 +24,10 @@ pytest-asyncio = "0.24.0"
 pytest-cov = "5.0.0"
 ruff = "0.6.4"
 
+
+[tool.poetry.group.docs.dependencies]
+pdoc = "^14.7.0"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"