fixed up workflows, added app skeleton, made sample test

jar2333 · Mar 17, 2024 · 5d3ee6c · 5d3ee6c
1 parent 4d4226b
commit 5d3ee6c
Show file tree

Hide file tree

Showing 8 changed files with 169 additions and 3 deletions.
diff --git a/.github/workflows/main-documentation.yaml b/.github/workflows/main-documentation.yaml
@@ -28,7 +28,7 @@ jobs:
 
       # ADJUST THIS: build your documentation into docs/.
       # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
-      - run: pdoc -o docs/
+      - run: pdoc app.py -o docs/
 
       - uses: actions/upload-pages-artifact@v3
         with:

diff --git a/.github/workflows/main_lint_test.yml b/.github/workflows/main_lint_test.yml
@@ -30,7 +30,7 @@ jobs:
         pip install -r requirements.txt
     - name: Lint with Ruff
       run: |
-        ruff --output-format=github .
+        ruff check --output-format=github .
       continue-on-error: true
     - name: Test with pytest
       run: |

diff --git a/.gitignore b/.gitignore
@@ -169,4 +169,6 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/
+
+.ruff_cache
diff --git a/app.py b/app.py
@@ -0,0 +1,10 @@
+from flask import Flask
+
+"""
+The main application
+"""
+app = Flask(__name__)
+
+@app.route("/")
+def root():
+    return "hello world"
diff --git a/docs/app.html b/docs/app.html
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./app.html"/>
+</head>
+</html>
diff --git a/docs/search.js b/docs/search.js
diff --git a/tests/sample_test.py b/tests/sample_test.py
@@ -0,0 +1,2 @@
+def sample_test():
+    assert True