feat: Migrating demos to Sphinx

Refs: #54

Reviewed-by: vedpatwardhan
Reviewed-by: guillesanbri

.github/workflows/docs.yml

@@ -1,32 +1,51 @@
+name: Update docs
 on:
-  workflow_dispatch:
   push:
-    branches: main
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 
-name: Docs Publish
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
-  build-deploy:
+  update-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
     steps:
-      - name: Check out repository
-        uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v3
 
-      - name: Set up Quarto
-        uses: quarto-dev/quarto-actions/setup@v2
+      - name: Checkout 🛎️ Doc-builder
+        uses: actions/checkout@v3
+        with:
+          repository: unifyai/doc-builder
+          path: .doc-builder
 
-      - name: Install Python and Dependencies
+      - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
-          cache: 'pip'
-      - run: pip install -r requirements.txt
+          python-version: 3.8
+
+      - name: Build docs
+        run: |
+          ./.doc-builder/make_docs_without_docker.sh ..
 
-      - name: Render and Publish
-        uses: quarto-dev/quarto-actions/publish@v2
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
         with:
-          target: gh-pages
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          path: 'docs/build'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+

.gitignore

@@ -1,7 +1,7 @@
-/.quarto/
-/docs/
+.vscode
 .idea/*
 **/.ipynb_checkpoints/*
 **pem**
 **fn_path_cache**
-*.DS_Store
+*.DS_Store
+build/

README.md

@@ -23,4 +23,11 @@ To ensure that similar formats are used across the demo notebooks, a template is
 - The h3 (###) tags are used for subsection titles.
 - All steps and explanation should go with the default, which is text or paragraph (p) without any tags.
 
-4. Lastly, you have to include the new notebook path in the corresponding position in the listings of the files `_quarto.yml` and `index.qmd`.
+4. You have to include the new notebook path in the corresponding `toctree` which
+is located in [index.rst](docs/index.rst). This is to ensure that the notebook is rendered in the contents in the left of the webpage.
+
+5. You may need to add a `grid-item-card` in the [index.rst](docs/index.rst) file to link
+the notebook to the webpage. Please refer to the existing examples for the format. You may
+also look into the [`grid-item-card`](https://sphinx-design.readthedocs.io/en/latest/grids.html)
+documentation, or the [`card`](https://sphinx-design.readthedocs.io/en/latest/cards.html)
+documentation on `sphinx-design` website.