Add AGPL-3.0 license and GitHub Actions deployment workflow

Author: milanofthe

.github/workflows/deploy.yml

@@ -0,0 +1,72 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Python dependencies
+        run: pip install -r scripts/requirements.txt
+
+      - name: Clone PathSim repositories for API extraction
+        run: |
+          git clone --depth 1 https://github.com/pathsim/pathsim.git ../pathsim
+          git clone --depth 1 https://github.com/pathsim/pathsim-chem.git ../pathsim-chem
+          git clone --depth 1 https://github.com/pathsim/pathsim-vehicle.git ../pathsim-vehicle
+
+      - name: Extract API documentation
+        run: python scripts/extract-api.py
+
+      - name: Prepare notebooks
+        run: python scripts/prepare-notebooks.py
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        env:
+          BASE_PATH: '/${{ github.event.repository.name }}'
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

LICENSE

@@ -357,7 +357,8 @@ def extract(self) -> dict:
 
                 try:
                     module_data = self._extract_module(module_path)
-                    if module_data and (module_data["classes"] or module_data["functions"] or module_data["docstring_html"]):
+                    # Only include modules that have classes or functions (not just docstrings)
+                    if module_data and (module_data["classes"] or module_data["functions"]):
                         result["modules"][module_path] = module_data
                         class_count = len(module_data["classes"])
                         func_count = len(module_data["functions"])
@@ -419,12 +420,11 @@ def _empty_result(self) -> dict:
 
     def _extract_module_obj(self, obj: griffe.Object, module_path: str) -> dict | None:
         """Extract module data from griffe object - only items defined here."""
-        docstring = obj.docstring.value if obj.docstring else ""
-
+        # Skip module-level docstrings - only extract classes and functions
         module_data = {
             "name": module_path,
-            "description": extract_first_line(docstring),
-            "docstring_html": rst_to_html(docstring),
+            "description": "",
+            "docstring_html": "",
             "classes": [],
             "functions": [],
         }

scripts/extract-api.py

@@ -306,6 +306,14 @@ pre {
 	padding: var(--space-md);
 }
 
+/* Notebook images - ensure responsive scaling */
+.notebook img,
+.notebook-cells img,
+.cell-outputs img {
+	max-width: 100%;
+	height: auto;
+}
+
 pre code {
 	background: none;
 	padding: 0;
@@ -1363,3 +1371,55 @@ pre.output-text {
 .gap-lg {
 	gap: var(--space-lg);
 }
+
+/* ============================================
+   CODE BLOCK SHARED STYLES
+   Used by MarkdownRenderer, RstRenderer, DocstringRenderer
+   ============================================ */
+
+.code-block-wrapper {
+	margin: var(--space-md) 0;
+	border: 1px solid var(--border);
+	border-radius: var(--radius-lg);
+	overflow: hidden;
+}
+
+.code-block-header {
+	display: flex;
+	align-items: center;
+	justify-content: space-between;
+	padding: var(--space-xs) var(--space-md);
+	background: var(--surface-raised);
+	border-bottom: 1px solid var(--border);
+}
+
+.code-copy-btn {
+	display: flex;
+	align-items: center;
+	justify-content: center;
+	padding: var(--space-xs);
+	background: transparent;
+	border: none;
+	border-radius: var(--radius-sm);
+	color: var(--text-muted);
+	cursor: pointer;
+	transition: color var(--transition-fast), background var(--transition-fast);
+}
+
+.code-copy-btn:hover {
+	color: var(--text);
+	background: var(--surface-hover);
+}
+
+.code-copy-btn.copied {
+	color: var(--success);
+}
+
+.cm-container {
+	background: var(--surface);
+}
+
+.cm-container .cm-editor {
+	font-size: var(--font-base);
+	max-height: 300px;
+}

src/app.css

@@ -2,13 +2,6 @@
   "package": "pathsim_chem",
   "display_name": "PathSim-Chem",
   "modules": {
-    "pathsim_chem": {
-      "name": "pathsim_chem",
-      "description": "PathSim-Chem: Chemical Engineering Blocks for PathSim",
-      "docstring_html": "<p>PathSim-Chem: Chemical Engineering Blocks for PathSim</p>\n<p>A toolbox providing specialized blocks for chemical engineering simulations\nin the PathSim framework.</p>\n",
-      "classes": [],
-      "functions": []
-    },
     "pathsim_chem.tritium.bubbler": {
       "name": "pathsim_chem.tritium.bubbler",
       "description": "",
@@ -111,8 +104,8 @@
     },
     "pathsim_chem.tritium.glc": {
       "name": "pathsim_chem.tritium.glc",
-      "description": "Bubble column gas-liquid contactor model solver.",
-      "docstring_html": "<p>Bubble column gas-liquid contactor model solver.</p>\n<p>This module solves the coupled, non-linear, second-order ordinary differential\nequations that describe tritium transport in a counter-current bubble column,\nbased on the model by C. Malara (1995).</p>\n",
+      "description": "",
+      "docstring_html": "",
       "classes": [
         {
           "name": "GLC",

src/lib/api/generated/chem.json

@@ -3,7 +3,6 @@
 
 import pathsimData from './pathsim.json';
 import chemData from './chem.json';
-import vehicleData from './vehicle.json';
 
 export interface APIParameter {
   name: string;
@@ -68,7 +67,6 @@ export interface APIPackage {
 export const apiData: Record<string, APIPackage> = {
   pathsim: pathsimData as APIPackage,
   chem: chemData as APIPackage,
-  vehicle: vehicleData as APIPackage,
 };
 
 export default apiData;

src/lib/api/generated/index.ts

@@ -6,7 +6,7 @@
 	import { theme } from '$lib/stores/themeStore';
 	import { processCrossRefs, lookupRef } from '$lib/utils/crossref';
 	import { searchTarget } from '$lib/stores/searchNavigation';
-	import { COPY_FEEDBACK_DURATION } from '$lib/config/timing';
+	import { createCopyButton } from '$lib/utils/copyButton';
 
 	interface Props {
 		html: string;
@@ -212,30 +212,6 @@
 		return 'python';
 	}
 
-	// Create copy button with icon
-	function createCopyButton(code: string): HTMLButtonElement {
-		const button = document.createElement('button');
-		button.className = 'code-copy-btn';
-		button.title = 'Copy to clipboard';
-		button.innerHTML = `<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="9" y="9" width="13" height="13" rx="2" ry="2"></rect><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"></path></svg>`;
-
-		button.addEventListener('click', async () => {
-			try {
-				await navigator.clipboard.writeText(code);
-				button.classList.add('copied');
-				button.innerHTML = `<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="20 6 9 17 4 12"></polyline></svg>`;
-				setTimeout(() => {
-					button.classList.remove('copied');
-					button.innerHTML = `<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="9" y="9" width="13" height="13" rx="2" ry="2"></rect><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"></path></svg>`;
-				}, COPY_FEEDBACK_DURATION);
-			} catch (e) {
-				console.warn('Failed to copy:', e);
-			}
-		});
-
-		return button;
-	}
-
 	// Render code blocks with CodeMirror
 	async function renderCodeBlocks() {
 		if (!container) return;
@@ -434,55 +410,7 @@
 		margin-bottom: 0;
 	}
 
-	/* Code block wrapper */
-	.docstring-content :global(.code-block-wrapper) {
-		margin: var(--space-md) 0;
-		border: 1px solid var(--border);
-		border-radius: var(--radius-lg);
-		overflow: hidden;
-	}
-
-	/* Code block header - styled like panel-header */
-	.docstring-content :global(.code-block-header) {
-		display: flex;
-		align-items: center;
-		justify-content: space-between;
-		padding: var(--space-xs) var(--space-md);
-		background: var(--surface-raised);
-		border-bottom: 1px solid var(--border);
-	}
-
-	
-	.docstring-content :global(.code-copy-btn) {
-		display: flex;
-		align-items: center;
-		justify-content: center;
-		padding: var(--space-xs);
-		background: transparent;
-		border: none;
-		border-radius: var(--radius-sm);
-		color: var(--text-muted);
-		cursor: pointer;
-		transition: color var(--transition-fast), background var(--transition-fast);
-	}
-
-	.docstring-content :global(.code-copy-btn:hover) {
-		color: var(--text);
-		background: var(--surface-hover);
-	}
-
-	.docstring-content :global(.code-copy-btn.copied) {
-		color: var(--success, #22c55e);
-	}
-
-	.docstring-content :global(.cm-container) {
-		background: var(--surface);
-	}
-
-	.docstring-content :global(.cm-editor) {
-		font-size: var(--font-base);
-		max-height: 300px;
-	}
+	/* Code block styles are in app.css */
 
 	/* Parameter/Attribute tables - panel style */
 	.docstring-content :global(.param-table-wrapper) {