adapted template

Author: isaac-cf-wong

.github/workflows/sphinx.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   pages:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     environment:
       name: github-pages
       # url: ${{ steps.deployment.outputs.page_url }}

.gitignore

@@ -129,4 +129,4 @@ dmypy.json
 .pyre/
 
 # Mac metadata files
-.DS_store
+.DS_store

docs/conf.py

@@ -4,8 +4,9 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
+from __future__ import annotations
 
+# -- Path setup --------------------------------------------------------------
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

docs/devcontainer.md

@@ -1,7 +1,7 @@
 # GitHub Codespace
 
 The project's Codespace configuration is located in ".devcontainer". It includes the "Dockerfile" for the development container.
-The project can be opened directly in a Codespace. 
+The project can be opened directly in a Codespace.
 
 ## Running Unit Tests
 

docs/pre-commit-config.md

@@ -1,6 +1,6 @@
 # pre-commit-config.yaml
 
 Pre-commit is a Python package which can be used to create 'git' hooks which scan can prior to checkins.
-The included configuration focuses on python actions which will help to prevent users from commiting code which will fail during builds.
-In general, only formatting actions are automatiicaly performed. These include auto-formatting with 'black', or sorting dependacies with 'isort'. 
+The included configuration focuses on python actions which will help to prevent users from committing code which will fail during builds.
+In general, only formatting actions are automatiicaly performed. These include auto-formatting with 'black', or sorting dependacies with 'isort'.
 Linting actions are left to the discretion of the user.