add user doc (testing)

.github/workflows/netlify.yml → .github/workflows/netlify_app.yml

@@ -1,4 +1,4 @@
-name: Build and Deploy to Netlify
+name: Build and Deploy App to Netlify
 on:
   push:
   pull_request:

.github/workflows/netlify_docs.yml

@@ -0,0 +1,22 @@
+on:
+    workflow_dispatch:
+    push:
+      branches: main
+
+name: Quarto Publish User Docs
+jobs:
+    build-deploy:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Check out repository
+          uses: actions/checkout@v4 
+
+        - name: Set up Quarto
+          uses: quarto-dev/quarto-actions/setup@v2
+
+        - name: Render and Publish 
+          uses: quarto-dev/quarto-actions/publish@v2
+          with:
+            target: netlify
+            path: docs
+            NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}

dev/list-proto.ipynb

@@ -0,0 +1,91 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# List Protocol"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sys\n",
+    "from pyhere import here\n",
+    "from pathlib import Path\n",
+    "import pandas as pd\n",
+    "sys.path.insert(1, str(Path.cwd().parent)) \n",
+    "\n",
+    "from designcter.proto import protocols, exam_id_protocol_id, protocols_id_name"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create DF"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 15,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'protocol_name': 'Routine WA',\n",
+       " 'exam_name': 'CTWA',\n",
+       " 'phase_design_text': '\\n- Venous (whole)\\n- Delay (liver)\\n',\n",
+       " 'contrast_text': 'Oral (limited water), Rectal (water)'}"
+      ]
+     },
+     "execution_count": 15,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "protocols[\"ct_wa_routine\"]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 31,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "protocols_df = pd.DataFrame({\n",
+    "    \"protocol_name\": [protocols[k][\"protocol_name\"] for k in protocols.keys()],\n",
+    "    \"exam_name\": [protocols[k][\"exam_name\"] for k in protocols.keys()],\n",
+    "    \"phase_design_text\": [protocols[k][\"phase_design_text\"] for k in protocols.keys()],\n",
+    "    \"contrast_text\": [protocols[k][\"contrast_text\"] for k in protocols.keys()],\n",
+    "})"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.10"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/.gitignore

@@ -0,0 +1,3 @@
+/.quarto/
+_out/*
+!_out/*.docx

docs/_publish.yml

@@ -0,0 +1,4 @@
+- source: docs.qmd
+  netlify:
+    - id: eb3bf39d-e7c3-464a-8eb4-f4f6ee60ceb6
+      url: 'https://design-cter-userguide.netlify.app'

docs/_quarto.yml

@@ -0,0 +1,10 @@
+project:
+  title: "docs"
+  output-dir: "_out"
+
+format: 
+  html: default
+  docx: default
+
+freeze: true
+

docs/docs.qmd

@@ -0,0 +1,9 @@
+---
+title: "docs"
+---
+
+## Quarto
+
+Hello
+
+Quarto enables you to weave together content and executable code into a finished document. To learn more about Quarto see <https://quarto.org>.