feat: add pdoc for leveraging python docstrings for documentation (#501)

* feat: add pdoc for leveraging python docstrings for documentation

* chore: add imports for public APIs

Author: allenporter

.github/workflows/pages.yml

@@ -0,0 +1,45 @@
+---
+name: Deploy static content to Pages
+
+on:
+  push:
+    branches:
+      - main
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+  actions: read
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v5
+      - uses: snok/install-poetry@v1.4.1
+      - name: Install Dependencies
+        run: poetry install
+        shell: bash
+      - run: pdoc ./roborock -o docs/pdoc
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload pdoc output
+          path: 'docs/pdoc/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

poetry.lock

@@ -51,6 +51,7 @@ aioresponses = "^0.7.7"
 freezegun = "^1.5.1"
 pytest-timeout = "^2.3.1"
 syrupy = "^4.9.1"
+pdoc = "^15.0.4"
 
 [tool.semantic_release]
 branch = "main"

pyproject.toml

@@ -1,7 +1,39 @@
-"""Roborock API."""
+"""Roborock API.
+
+.. include:: ../README.md
+"""
 
 from roborock.b01_containers import *
 from roborock.code_mappings import *
 from roborock.containers import *
 from roborock.exceptions import *
 from roborock.roborock_typing import *
+
+from . import (
+    b01_containers,
+    clean_modes,
+    cloud_api,
+    code_mappings,
+    const,
+    containers,
+    exceptions,
+    roborock_typing,
+    version_1_apis,
+    version_a01_apis,
+    web_api,
+)
+
+__all__ = [
+    "web_api",
+    "version_1_apis",
+    "version_a01_apis",
+    "containers",
+    "b01_containers",
+    "const",
+    "cloud_api",
+    "clean_modes",
+    "code_mappings",
+    "roborock_typing",
+    "exceptions",
+    # Add new APIs here in the future when they are public e.g. devices/
+]