feat: add docs

Author: ErikKalkoken

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: website
+
+# build the documentation whenever there are new commits on main
+on:
+    push:
+        branches:
+            - main
+        # Alternative: only build for tags.
+        # tags:
+        #   - '*'
+
+# security: restrict permissions for CI jobs.
+permissions:
+    contents: read
+
+jobs:
+    # Build the documentation and upload the static HTML files as an artifact.
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v6
+              with:
+                  persist-credentials: false
+            - uses: actions/setup-python@v6
+              with:
+                  python-version: "3.14"
+
+            - run: pip install -e ".[docs]"
+            # ADJUST THIS: build your documentation into docs/.
+            # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
+            - run: pdoc -o docs/ --docformat="google" vlogs_handler
+
+            - uses: actions/upload-pages-artifact@v4
+              with:
+                  path: docs/
+
+    # Deploy the artifact to GitHub pages.
+    # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+    deploy:
+        needs: build
+        runs-on: ubuntu-latest
+        permissions:
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+            - id: deployment
+              uses: actions/deploy-pages@v4

pyproject.toml

@@ -29,6 +29,7 @@ Home = "https://github.com/ErikKalkoken/python-victorialogs-handler"
 
 [project.optional-dependencies]
 test = ["coverage"]
+docs = ["pdoc"]
 
 [tool.flit.module]
 name = "vlogs_handler"

src/vlogs_handler/__init__.py

@@ -6,7 +6,3 @@
 __version__ = "0.1.0dev7"
 
 __all__ = ["VictoriaLogsHandler"]
-
-# TODO
-# - Enable logging and switch to full debug logging in prod for testing
-# - Consider using a persistent queue