setup docs publish

Author: ElectricalBoy

.github/workflows/publish.yml

@@ -31,3 +31,44 @@ jobs:
 
       - name: Publish
         run: uv publish
+
+  # Build the documentation and upload the static HTML files as an artifact.
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Setup project
+        run: uv sync --all-extras --dev
+
+      - name: Build docs
+        run: uv run pdoc lpdb_python.defs lpdb_python.session lpdb_python.async_session -t docs/ -o output/docs/
+        env:
+          VERSION: ${{ github.ref_name }}
+
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: output/docs/
+
+  deploy:
+    needs: build-docs
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/module.html.jinja2

@@ -0,0 +1,9 @@
+{% extends "default/module.html.jinja2" %}
+
+{% block nav_footer %}
+    <footer>
+        lpdb_python {{ env["VERSION"] | default("0.0.0") }}
+        <br />
+        <a href="https://github.com/ElectricalBoy/LPDB_python"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/ElectricalBoy/lpdb_python" /></a>
+    </footer>
+{% endblock %}

pyproject.toml

@@ -32,7 +32,8 @@ async = [
 [dependency-groups]
 dev = [
     {include-group = "test"},
-    {include-group = "lint"}
+    {include-group = "lint"},
+    {include-group = "docs"}
 ]
 test = [
     "pytest",
@@ -41,6 +42,9 @@ test = [
 lint = [
     "black",
 ]
+docs = [
+    "pdoc",
+]
 
 [tool.pytest.ini_options]
 pythonpath = [