docs updates

RTIInternational · Feb 12, 2024 · 85a5822 · 85a5822
1 parent 00d4279
commit 85a5822
Show file tree

Hide file tree

Showing 85 changed files with 904 additions and 692 deletions.
diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml
@@ -3,6 +3,7 @@ name: documentation
 on:
   push:
     branches: [112-add-documentation]
+    # tags: [ 'v*.*.*' ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
diff --git a/README.md b/README.md
@@ -13,11 +13,15 @@ assess their skill and performance.
 
 NOTE: THIS PROJECT IS UNDER DEVELOPMENT - EXPECT TO FIND BROKEN AND INCOMPLETE CODE.
 
+## Documentation
+[TEEHR Documentation](https://rtiinternational.github.io/teehr/)
+
 ## How to Install TEEHR
 Install poetry
 ```bash
 $ pipx install poetry
 ```
+
 Install from source
 ```bash
 # Create and activate python environment, requires python >= 3.10

diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/database/teehr_dataset/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/database/teehr_dataset/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/loading/nextgen/ngen/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/loading/nextgen/ngen/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm22_grid/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm22_grid/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm22_point/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm22_point/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm30_grid/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm30_grid/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm30_point/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/models/loading/nwm30_point/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/models/queries/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/models/queries/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/models/queries_database/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/models/queries_database/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/queries/duckdb/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/queries/duckdb/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/queries/duckdb_database/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/queries/duckdb_database/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/queries/pandas/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/queries/pandas/index.doctree
diff --git a/docs/sphinx/_build/doctrees/autoapi/teehr/queries/utils/index.doctree b/docs/sphinx/_build/doctrees/autoapi/teehr/queries/utils/index.doctree
diff --git a/docs/sphinx/_build/doctrees/changelog/index.doctree b/docs/sphinx/_build/doctrees/changelog/index.doctree
diff --git a/docs/sphinx/_build/doctrees/development/index.doctree b/docs/sphinx/_build/doctrees/development/index.doctree
diff --git a/docs/sphinx/_build/doctrees/environment.pickle b/docs/sphinx/_build/doctrees/environment.pickle
diff --git a/docs/sphinx/_build/doctrees/generated/teehr.doctree b/docs/sphinx/_build/doctrees/generated/teehr.doctree
diff --git a/docs/sphinx/_build/doctrees/getting_started/index.doctree b/docs/sphinx/_build/doctrees/getting_started/index.doctree
diff --git a/...sphinx/_build/html/_downloads/074212d9cab0d4da5bc9827aca373ee9/grid_loading_example.ipynb b/...sphinx/_build/html/_downloads/074212d9cab0d4da5bc9827aca373ee9/grid_loading_example.ipynb
@@ -38,7 +38,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Specify input variables"
+    "## Specify input variables"
    ]
   },
   {
@@ -97,7 +97,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Fetch a template forcing netCDF file"
+    "## Fetch a template forcing netCDF file"
    ]
   },
   {
@@ -117,7 +117,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Fetch some example polygons (nextgen divides)"
+    "## Fetch some example polygons (nextgen divides)"
    ]
   },
   {
@@ -136,7 +136,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Start a local dask cluster"
+    "## Start a local dask cluster"
    ]
   },
   {
@@ -157,7 +157,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Generate the weights file"
+    "## Generate the weights file"
    ]
   },
   {
@@ -185,7 +185,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Fetch the gridded data summarized to the polygons"
+    "## Fetch the gridded data summarized to the polygons"
    ]
   },
   {