github pages

.gitattributes

@@ -5,4 +5,4 @@
 /tests/ export-ignore
 /phpstan.neon.dist export-ignore
 /.github/ export-ignore
-/Docs/ export-ignore
+/phpdoc.dist.xml export-ignore

.github/workflows/phpdoc.yml

@@ -0,0 +1,45 @@
+name: Deploy static content to Pages
+
+on:
+  push:
+    branches: ["master"]
+
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  phpdoc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+      - name: Build with phpDocumentor
+        run: docker run --rm --volume "$(pwd):/data" phpdoc/phpdoc:3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs'
+      - name: Cache phpDocumentor build files
+        id: phpdocumentor-cache
+        uses: actions/cache@v3
+        with:
+          path: .phpdoc/cache
+          key: ${{ runner.os }}-phpdocumentor-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-phpdocumentor-
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -6,3 +6,6 @@ nbproject*
 /.phpunit.cache/
 .unlock_css_optimiser
 /phpstan.neon
+/phpdoc.xml
+/.phpdoc
+/docs