Improve developer documentation (#1908)

## Enhancement
- Publish detailed developer documentation via GitHub Pages
[imicknl.github.io/python-overkiz-api](https://imicknl.github.io/python-overkiz-api/).

Fixes #190, #1522

Author: iMicknl

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: docs
+
+on:
+  release:
+    types:
+      - created
+  pull_request:
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - pyproject.toml
+      - README.md
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install docs dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Build site
+        run: uv run mkdocs build
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-json
-        exclude: .devcontainer
+        exclude: .devcontainer|.vscode
     -   id: check-yaml
     -   id: check-added-large-files
     -   id: no-commit-to-branch

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Docs: Serve (development)",
+            "type": "shell",
+            "command": "uv run mkdocs serve"
+        },
+        {
+            "label": "Docs: Build",
+            "type": "shell",
+            "command": "uv run mkdocs build --clean"
+        },
+    ]
+}

docs/api-reference.md

@@ -0,0 +1,13 @@
+::: pyoverkiz.client.OverkizClient
+
+::: pyoverkiz.models
+    options:
+      show_source: false
+
+::: pyoverkiz.enums
+    options:
+      show_source: false
+
+::: pyoverkiz.exceptions
+    options:
+      show_source: false