Merge pull request #94 from arjbingly/sphinx

Add Sphinx Docs

.github/workflows/build_linting.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   linting:
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4

.github/workflows/linting.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   lint:
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4

.github/workflows/sphinx-gitpg.yml

@@ -1,24 +1,39 @@
 name: Docs build and upload
 
 on:
-  pull_request:
+  push:
     branches:
       - main
 
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
 jobs:
   docs:
-    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+      runs-on: ubuntu-latest
     steps:
-      - name: Check out repository code
+      - name: Checkout
         uses: actions/checkout@v4
 
       - name: Sphinx Build
         uses: ammaraskar/sphinx-action@master
         with:
           docs-folder: "src/docs/"
 
-      - name: Github Pages upload
-        uses: actions/upload-artifact@v4
-        with:
-          name: DocumentationHTML
-          path: "src/docs/_build/html/"
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -166,3 +166,4 @@ cython_debug/
 .idea/
 **/others
 data/
+full_report/Latex_report/Capstone5_report_v2.tex