rev

Author: victor-openai

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: Deploy docs
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+permissions:
+  contents: write # This allows pushing to gh-pages
+
+jobs:
+  deploy_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Deploy docs
+        run: make deploy-docs

Makefile

@@ -0,0 +1,15 @@
+.PHONY: sync build-docs serve-docs deploy-docs
+
+sync:
+	uv sync -q
+
+build-docs:
+	uv run mkdocs build
+
+serve-docs:
+	uv run mkdocs serve
+
+deploy-docs: build-docs
+	@echo "Docs built. Upload step goes here (GitHub Pages action can handle deploy)."
+
+

docs/index.md

@@ -0,0 +1,11 @@
+# Victor OpenAI Example
+
+This is a minimal Python package used to exercise CI.
+
+Example usage:
+
+```python
+from victor_openai_example import Example
+
+print(Example("World").greet())
+```

main.py

@@ -0,0 +1,8 @@
+site_name: Victor OpenAI Example
+theme:
+  name: material
+
+nav:
+  - Home: index.md
+
+

mkdocs.yml

@@ -5,3 +5,16 @@ description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.12"
 dependencies = []
+
+[dependency-groups]
+dev = [
+  "mkdocs",
+  "mkdocs-material",
+]
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["victor_openai_example"]

pyproject.toml

@@ -0,0 +1,12 @@
+class Example:
+    """A minimal example class exported by the package."""
+
+    def __init__(self, name: str) -> None:
+        self.name = name
+
+    def greet(self) -> str:
+        return f"Hello, {self.name}!"
+
+__all__ = ["Example"]
+
+