Jenny's demo notebook

.github/workflows/dev.yml

@@ -1,4 +1,4 @@
-name: test-format-render
+name: format-test
 
 on:
   push:
@@ -7,11 +7,34 @@ on:
     branches: [dev]
 
 jobs:
+  format:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+      - name: Install project
+        run: |
+          poetry install
+      - name: Format code with black
+        run: |
+          poetry run black .
+      - name: Commit and push changes to repository
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: 'Automated code format'
+
   test:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.12"]
+        python-version: ["3.10", "3.12", "3.13"]
         poetry-version: [latest]
         os: [ubuntu-latest]
     defaults:
@@ -32,27 +55,4 @@ jobs:
         run: |
           poetry run pytest tests
     outputs:
-      matrix: ${{ toJson(matrix) }}
-
-  render:
-    needs: test
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.12'
-      - name: Install and configure Poetry
-        uses: snok/install-poetry@v1
-      - name: Install project
-        run: |
-          poetry install
-      - name: Format code with black
-        run: |
-          poetry run black .
-      - name: Commit and push changes to repository
-        uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: 'Automated code format'
+      matrix: ${{ toJson(matrix) }}

.gitignore

@@ -1,9 +1,9 @@
-# Temporarily ignoring docs folder until I learn how to automate Sphinx doc build
-docs
-
 # VSCode files
 .vscode
 
+# demo files
+docs/data/
+
 # Byte-compiled / optimized / DLL files
 *__pycache__/
 *.py[cod]
@@ -114,8 +114,8 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
-# mkdocs documentation
-/site
+# rendered documentation
+_site/
 
 # mypy
 .mypy_cache/

News

@@ -1,5 +1,13 @@
 # All updates will be detailed here
 
+## Version 1.1.4
+
+- Added a demo project by Jenny Xu
+
+## Version 1.1.3
+
+- Migrated from Sphinx to Quarto documentation
+
 ## Version 1.1.2
 
 - Updated dependencies

_quarto.yml

@@ -1,13 +1,23 @@
 project:
   type: website
-  output-dir: docs
+  output-dir: _site
 
 website:
   title: "imfp"
   navbar:
     left:
       - href: index.qmd
         text: Home
+      - href: docs/demo.qmd
+        text: Demo
+    right:
+      - icon: github
+        href: https://github.com/Promptly-Technologies-LLC/imfp
+  page-footer:
+    left: "Copyright 2024, Promptly Technologies, LLC. MIT License."
+    right:
+      - icon: github
+        href: https://github.com/Promptly-Technologies-LLC/imfp
 
 format:
   html: