Automatically deploy extensive documentation

Author: amgebauer

.github/workflows/deploy_pages.yml

@@ -0,0 +1,33 @@
+name: deploy_pages
+
+on:
+  workflow_run:
+    workflows: [documentation]
+    types: [completed]
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    if: ${{ github.event.workflow_run.conclusion == 'success'}}
+    steps:
+      - uses: dawidd6/action-download-artifact@v11
+        with:
+          workflow: documentation.yml
+          name: documentation
+          path: ${{ github.workspace }}/docs
+          branch: ${{ github.event.repository.default_branch }}
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: ${{ github.workspace }}/docs
+          retention-days: 1
+      - uses: actions/deploy-pages@v4

.github/workflows/documentation.yml

@@ -0,0 +1,27 @@
+name: documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          pip install -r requirements-dev.txt
+          pip install -e .
+      - name: Create documentation
+        run: pdoc biomesh -o docs
+      - uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/
+          if-no-files-found: error

.github/workflows/pre-commit.yml

@@ -9,8 +9,10 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
-    - uses: pre-commit/action@v3.0.1
-      env:
-        SKIP: no-commit-to-branch
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.12"
+      - uses: pre-commit/action@v3.0.1
+        env:
+          SKIP: no-commit-to-branch

.gitignore

@@ -2,3 +2,4 @@ venv
 .pytest_cache
 __pycache__
 *.pyc
+docs/

README.md

@@ -19,7 +19,7 @@ pip install gmsh
 ## :book: Usage
 
 `biomesh` is composed of multiple utilities for working with complex biomechanical geometries. Below
-are some common workflows
+are some common workflows. Extensive documentation can be found [here](https://tum-lnm.github.io/biomesh/docs).
 
 ### Generate a mesh from colored STL files
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "biomesh"
-version = "0.6.0"
+version = "0.6.1"
 authors = [
   { name="The biomesh Authors" },
 ]