(fix) Fix the CI to use Sphinx to build and deploy the doc (#11)

Author: Bossy-Romain

.github/workflows/ci.yml

@@ -1,29 +1,42 @@
 name: ci
+
 on:
   push:
     branches:
       - master
       - main
-permissions:
-  contents: write
+
 jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs-material
-      - run: mkdocs gh-deploy --force
+    build-deploy:
+        name: Build and deploy the documentation
+        runs-on: ubuntu-latest
+        permissions:
+          contents: write
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with: 
+                submodules: true
+
+            - name: Setup Python
+              uses: actions/setup-python@v5
+              with:
+                python-version: '3.11'
+            
+            - name: Install dependencies
+              run: |
+                sudo apt-get update
+                sudo apt-get install -y make
+                python -m pip install -U pip
+                pip install -r requirements.txt
+                pip install ghp-import
+            
+            - name: Build
+              run: |
+                cd docs
+                make html
+
+            - name: Deploy on the branch gh-pages
+              run: |
+                ghp-import -n -f -p ./docs/_build/html
+              

docs/_static/code_annotations.js

@@ -5,10 +5,7 @@ const cross_icon = '<path d="M2.343 13.657A8 8 0 1 1 13.658 2.343 8 8 0 0 1 2.34
 
 const icon_elem = '<svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-feed-plus sd-text-info code-annotation-icon" viewBox="0 0 16 16" aria-hidden="true">' + plus_icon + '</svg>';
 
-var selectedAnnotation = {
-    "icon": null,
-    "text": null
-}
+var selectedAnnotation = null;
 
 var selected_icon = null;
 var selected_text = null;
@@ -24,8 +21,7 @@ function areSelectedAnnotation() {
  * Update the selected annotation.
  */
 function selectAnnotation(icon, text) {
-    selectedAnnotation["icon"] = icon;
-    selectedAnnotation["text"] = text;
+    selectedAnnotation = {icon, text};
 }
 
 /**
@@ -34,9 +30,8 @@ function selectAnnotation(icon, text) {
  */
 function hideSelectedAnnotation() {
     if(areSelectedAnnotation()) {
-        hideAnnotation(selected_icon, selected_text);
-        selectedAnnotation["icon"] = null;
-        selectedAnnotation["text"] = null;
+        hideAnnotation(selectedAnnotation);
+        selectedAnnotation = null;
     }
 }
 
@@ -129,9 +124,9 @@ function onClickAnnotation(id) {
     const text = document.getElementById('code-annotation-text-' + id);
 
     if(text.style.display == "none") {
-        show_annotation(icon, text);
+        show_annotation({icon, text});
     } else {
-        hideAnnotation(icon, text);
+        hideAnnotation({icon, text});
     }
 }