Merge pull request #1 from ASE2024-orange/features/dka/docs

feature(documentation): deploy documentation on github pages
ASE2024-orange · Dec 7, 2024 · 1abe4aa · 1abe4aa
2 parents f53ee1a + fa70cf4
commit 1abe4aa
Show file tree

Hide file tree

Showing 30 changed files with 146 additions and 1,733 deletions.
diff --git a/.github/workflows/buildGithubPage.yml b/.github/workflows/buildGithubPage.yml
@@ -0,0 +1,31 @@
+name: "Publish documentation"
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+
+  publish-documentation:
+    name: Publish documentation
+    permissions:
+      id-token: "write"
+      pages: "write"
+
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - id: "checkout"
+        name: "Check out Git repository"
+        uses: "actions/checkout@v3"
+
+      - id: "upload-documentation"
+        name: "Upload Pages artifact"
+        uses: "actions/upload-pages-artifact@v2"
+        with:
+          path: "docs/"
+
+      - id: "deployment"
+        name: "Deploy documentation to GitHub Pages"
+        uses: "actions/deploy-pages@v2"
+
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+docs/api
+docs/client
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/thingy-docs-orange.iml b/.idea/thingy-docs-orange.iml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/README.md b/README.md
@@ -1 +1 @@
- 
+# Advanced Acident Detector Documentation
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
diff --git a/docs/assets/icons.js b/docs/assets/icons.js