Merge pull request #369 from RTIInternational/368-fix-user-guide-docs

368 fix user guide docs
RTIInternational · Jan 13, 2025 · 8217bda · 8217bda
2 parents b064799 + 17c7da0
commit 8217bda
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/.github/workflows/documentation-publish.yml b/.github/workflows/documentation-publish.yml
@@ -3,7 +3,7 @@ name: documentation
 on:
   push:
     tags: [ 'v*.*.*' ]
-    # branches: [346-fix-user-guide-notebooks]
+    # branches: [368-fix-user-guide-docs]
 
 permissions:
   contents: write
@@ -12,16 +12,18 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install sphinx==7.4.7 pydata-sphinx-theme==0.16.0 myst-nb==1.1.2 sphinx-design numpy==1.26.4 numpydoc ghp-import pickleshare -e .
+          pip install poetry
+          poetry config virtualenvs.create false
+          poetry install
           python -m teehr.utils.install_spark_jars
 
       - name: Sphinx build
@@ -31,4 +33,5 @@ jobs:
 
       - name: Run ghp-import
         run: |
+          poetry add ghp-import
           ghp-import -n -p -f -o docs/sphinx/_build/html
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -78,6 +78,7 @@ def _get_project_meta():
 
 # -- MyST-NB options ---------------------------------------------------------
 nb_execution_mode = "auto"
+nb_execution_timeout = 300
 nb_output_stderr = "remove-warn"
 myst_enable_extensions = [
     "html_image"

diff --git a/docs/sphinx/user_guide/notebooks/08_adding_calculated_fields.ipynb b/docs/sphinx/user_guide/notebooks/08_adding_calculated_fields.ipynb
@@ -950,11 +950,11 @@
     "            \"event = true\",\n",
     "        ],\n",
     "        include_metrics=[\n",
-    "            teehr.Metrics.Maximum(\n",
+    "            teehr.SignatureMetrics.Maximum(\n",
     "                input_field_names=[\"primary_value\"],\n",
     "                output_field_name=\"max_primary_value\"\n",
     "            ),\n",
-    "            teehr.Metrics.Maximum(\n",
+    "            teehr.SignatureMetrics.Maximum(\n",
     "                input_field_names=[\"secondary_value\"],\n",
     "                output_field_name=\"max_secondary_value\"\n",
     "            )\n",
@@ -1007,11 +1007,11 @@
     "            \"event = true\",\n",
     "        ],\n",
     "        include_metrics=[\n",
-    "            teehr.Metrics.Maximum(\n",
+    "            teehr.SignatureMetrics.Maximum(\n",
     "                input_field_names=[\"primary_value\"],\n",
     "                output_field_name=\"max_primary_value\"\n",
     "            ),\n",
-    "            teehr.Metrics.Maximum(\n",
+    "            teehr.SignatureMetrics.Maximum(\n",
     "                input_field_names=[\"secondary_value\"],\n",
     "                output_field_name=\"max_secondary_value\"\n",
     "            )\n",
@@ -1020,7 +1020,7 @@
     "    .query(\n",
     "        group_by=[\"configuration_name\", \"primary_location_id\"],\n",
     "        include_metrics=[\n",
-    "            teehr.Metrics.RelativeBias(\n",
+    "            teehr.DeterministicMetrics.RelativeBias(\n",
     "                input_field_names=[\"max_primary_value\", \"max_secondary_value\"],\n",
     "                output_field_name=\"event_max_relative_bias\"\n",
     "            )\n",
@@ -1090,11 +1090,11 @@
     "            \"event90 = true\",\n",
     "        ],\n",
     "        include_metrics=[\n",
-    "            teehr.Metrics.Maximum(\n",
+    "            teehr.SignatureMetrics.Maximum(\n",
     "                input_field_names=[\"primary_value\"],\n",
     "                output_field_name=\"max_primary_value\"\n",
     "            ),\n",
-    "            teehr.Metrics.Maximum(\n",
+    "            teehr.SignatureMetrics.Maximum(\n",
     "                input_field_names=[\"secondary_value\"],\n",
     "                output_field_name=\"max_secondary_value\"\n",
     "            )\n",
@@ -1104,7 +1104,7 @@
     "    .query(\n",
     "        group_by=[\"configuration_name\", \"primary_location_id\"],\n",
     "        include_metrics=[\n",
-    "            teehr.Metrics.RelativeBias(\n",
+    "            teehr.DeterministicMetrics.RelativeBias(\n",
     "                input_field_names=[\"max_primary_value\", \"max_secondary_value\"],\n",
     "                output_field_name=\"event_90th_max_relative_bias\"\n",
     "            )\n",