Updated tests and docs

hydroserver2 · Jun 12, 2024 · 9cc177c · 9cc177c
1 parent b5ca1b1
commit 9cc177c
Show file tree

Hide file tree

Showing 211 changed files with 4,654 additions and 18,221 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,28 @@
+name: HydroServer SensorThings Generate Documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          sphinx-build docs _build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: docs
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -1,5 +1,5 @@
 name: HydroServer SensorThings PyPI Publish
-run-name: ${{ github.actor }} is running HydroServer SensorThings PyPI Publish on ${{ github.ref }}
+run-name: '${{ github.actor }} is running HydroServer SensorThings PyPI Publish on ${{ github.ref }}'
 
 on:
   release:
@@ -13,10 +13,10 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v3
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v3
         with:
-          python-version: '3.8'
+          python-version: '3.9'
 
       - name: Install dependencies
         run: |

diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
       - name: Checkout Repo
@@ -28,7 +28,6 @@ jobs:
           python -m pip install --upgrade pip
           pip install -e .
           pip install pytest
-          pip install mock
 
       - name: Run unit tests
         run: |

diff --git a/README.md b/README.md
@@ -22,19 +22,7 @@ MIDDLEWARE = [
 ]
 ```
 
-Then you may use a prebuilt API backend by adding one of the following to your `INSTALLED_APPS` setting:
-
-```
-INSTALLED_APPS = [
-	# ...
-	'sensorthings.backends.sensorthings',
-	'sensorthings.backends.odm2',
-	'sensorthings.backends.frostserver'
-	# ...
-]
-```
-
-Alternatively, you may initialize a custom SensorThings API using an existing backend as a template and adding it to your urls.py file:
+You may initialize a custom SensorThings API using an existing backend as a template and adding it to your urls.py file:
 
 ```
 from sensorthings import SensorThingsAPI

diff --git a/docs/.buildinfo b/docs/.buildinfo
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docsrc/Makefile → docs/Makefile b/docsrc/Makefile → docs/Makefile
@@ -5,20 +5,16 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-github:
-	@make html
-	@cp -a build/html/. ../docs
-
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_sources/hydrothings.backends.frostserver.rst.txt b/docs/_sources/hydrothings.backends.frostserver.rst.txt
diff --git a/docs/_sources/hydrothings.backends.odm2.rst.txt b/docs/_sources/hydrothings.backends.odm2.rst.txt
diff --git a/docs/_sources/hydrothings.backends.rst.txt b/docs/_sources/hydrothings.backends.rst.txt
diff --git a/docs/_sources/hydrothings.backends.sensorthings.rst.txt b/docs/_sources/hydrothings.backends.sensorthings.rst.txt
diff --git a/docs/_sources/hydrothings.components.datastreams.rst.txt b/docs/_sources/hydrothings.components.datastreams.rst.txt
diff --git a/docs/_sources/hydrothings.components.featuresofinterest.rst.txt b/docs/_sources/hydrothings.components.featuresofinterest.rst.txt
diff --git a/docs/_sources/hydrothings.components.historicallocations.rst.txt b/docs/_sources/hydrothings.components.historicallocations.rst.txt