Update Documentation

vicvalentim · Oct 30, 2024 · 7ddbbe2 · 7ddbbe2
1 parent 818f9ee
commit 7ddbbe2
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 294 deletions.
diff --git a/.github/workflows/deploy_website.yml b/.github/workflows/deploy_website.yml
@@ -1,26 +1,30 @@
-name: deploy_website
+name: Deploy Website
+
 on:
   push:
     branches:
       - main
+
 permissions:
   contents: write
 
 jobs:
   deploy:
     concurrency: ci-${{ github.ref }}
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.x
+          python-version: '3.x'
 
       - name: Install dependencies
-        run: pip install mkdocs-material
+        run: |
+          pip install mkdocs-dracula mkdocs-static-i18n mkdocs-material
 
       - name: Build website
         run: mkdocs build

diff --git a/.github/workflows/pr_preview.yml b/.github/workflows/pr_preview.yml
@@ -1,11 +1,13 @@
-name: Deploy PR preview
+name: Deploy PR Preview
+
 on:
   pull_request:
     types:
       - opened
       - reopened
       - synchronize
       - closed
+
 permissions:
   contents: write
   pull-requests: write
@@ -14,25 +16,38 @@ jobs:
   deploy-preview:
     concurrency: preview-${{ github.ref }}
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.x
+          python-version: '3.x'
 
       - name: Install dependencies
-        run: pip install mkdocs-material
+        run: |
+          pip install mkdocs-dracula mkdocs-static-i18n mkdocs-material
 
       - name: Build website
         if: github.event.action != 'closed'
         run: mkdocs build
 
       - name: Deploy preview
+        if: github.event.action != 'closed'
         uses: rossjrw/pr-preview-action@v1
         with:
           source-dir: site
           preview-branch: gh-pages
           umbrella-dir: pr-preview
+
+      - name: Remove preview on PR close
+        if: github.event.action == 'closed'
+        run: |
+          git config --global user.email "actions@github.com"
+          git config --global user.name "GitHub Actions"
+          git checkout gh-pages
+          git rm -rf pr-preview/${{ github.event.pull_request.number }}
+          git commit -m "Remove preview for PR #${{ github.event.pull_request.number }}"
+          git push origin gh-pages
diff --git a/docs/develop.md b/docs/develop.md
diff --git a/docs/example_sketch_output.jpg b/docs/example_sketch_output.jpg
diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/index.md b/docs/index.md