docs: adapted from eCLM

Author: jjokella

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - tsmp-pdaf-patched
+      - tsmp-pdaf-patched-doc
+
+env:
+  BASE_URL: /${{ github.event.repository.name }}
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+          cache: 'pip'
+
+      - name: Install dependencies
+        run:  pip install -r ${GITHUB_WORKSPACE}/docs/requirements.txt
+
+      - name: Build TSMP-PDAF doc homepage
+        working-directory: ./docs
+        run:  |
+          make clean docs
+
+      - name: Build eCLM Source Code browser
+        working-directory: ./docs
+        run:  |
+          make src-browser-lib
+
+      - name: Upload documentation artifacts
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "docs/_build/html"
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/FORD_options.md

@@ -0,0 +1,16 @@
+---
+project: TSMP-PDAF Source Code Browser
+author: HPSC TerrSys
+doc_license: mit
+base_url: https://hpscterrsys.github.io/pdaf/src
+project_github: https://github.com/HPSCTerrSys/pdaf
+---
+
+Test 1 2 3
+
+<!--
+FORD (FORtran Documenter) project options list:
+
+https://forddocs.readthedocs.io/en/latest/user_guide/project_file_options.html#project-file-options
+-->
+

docs/FORD_options_int.md

@@ -0,0 +1,16 @@
+---
+project: TSMP-PDAF Source Code Browser - Interface
+author: HPSC TerrSys
+doc_license: mit
+base_url: https://hpscterrsys.github.io/pdaf/interface
+project_github: https://github.com/HPSCTerrSys/pdaf
+---
+
+Test 1 2 3
+
+<!--
+FORD (FORtran Documenter) project options list:
+
+https://forddocs.readthedocs.io/en/latest/user_guide/project_file_options.html#project-file-options
+-->
+

docs/INDEX.md

@@ -0,0 +1,10 @@
+# TSMP-PDAF Documentation
+
+```{important}
+**Welcome!** You are viewing the first version of the documentation for TSMP-PDAF. This is a living document, which means it will be continuously updated and improved. Please check back regularly for the latest information and updates.
+
+This documentation is adapted from the eCLM-documentation: https://github.com/HPSCTerrSys/eCLM
+```
+
+```{tableofcontents}
+```

docs/Makefile

@@ -0,0 +1,19 @@
+BUILD_DIR = ./_build
+SRC_DIR_LIB = ../src
+SRC_DIR_INT = ../interface
+
+all: docs src-browser-lib src-browser-interface
+
+docs:
+	jupyter-book build -W -n --keep-going .
+
+src-browser-lib:
+	ford -d $(SRC_DIR_LIB) -o $(BUILD_DIR)/html/src FORD_options.md
+
+src-browser-interface:
+	ford -d $(SRC_DIR_INT) -o $(BUILD_DIR)/html/interface FORD_options_int.md
+
+.PHONY: clean
+
+clean:
+	jupyter-book clean .

docs/requirements.txt

@@ -0,0 +1,5 @@
+jupyter-book
+matplotlib
+numpy
+ghp-import
+ford