Adding documentation

Author: kks32

.github/workflows/docs.yml

@@ -0,0 +1,73 @@
+name: Deploy MkDocs
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+
+      - name: Install MkDocs
+        run: poetry add mkdocs mkdocs-material
+
+      - name: Build MkDocs site
+        run: poetry run mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -102,15 +102,6 @@ print(df)
 db.close()
 ```
 
-## Documentation
-
-View [dapi API doc](https://designsafe-ci.github.io/dapi/dapi/index.html)
-
-To generate API docs:
-
-```
-pdoc --html --output-dir docs dapi --force
-```
 
 ## Support
 
@@ -141,3 +132,26 @@ poetry run pytest -v
 * Krishna Kumar, University of Texas at Austin
 * Prof. Pedro Arduino, University of Washington
 * Prof. Scott Brandenberg, University of California Los Angeles
+
+
+## Documentation
+
+View [dapi API doc](https://designsafe-ci.github.io/dapi/dapi/index.html)
+
+### Running documentation locally
+
+To serve the MkDocs documentation locally:
+
+```shell
+poetry install
+poetry run mkdocs serve
+```
+
+This will start a local server at `http://127.0.0.1:8000/dapi/` where you can view the documentation.
+
+### API docs
+To generate API docs:
+
+```
+pdoc --html --output-dir docs dapi --force
+```