Merge pull request #8 from ACCESS-NRI/7-update-documentation

7 update documentation

.github/workflows/ci.yml → .github/workflows/ci_pytest.yml

@@ -1,4 +1,4 @@
-name: Continuous Integration
+name: CI pytest
 
 on: [push]
 

.github/workflows/ci_spelling.yml

@@ -0,0 +1,13 @@
+name: CI Spelling
+on: [push]
+jobs:
+  check-spelling:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Check Spelling
+        uses: rojopolis/[email protected]
+        with:
+          config_path: .spellcheck.yml
+          task_name: Markdown

.spellcheck.yml

@@ -0,0 +1,26 @@
+matrix:
+- name: Markdown
+  expect_match: false
+  apsell:
+    mode: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    output: wordlist.dic
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - markdown.extensions.extra:
+  - pyspelling.filters.html:
+      comments: false
+      attributes:
+      - alt
+      ignores:
+      - ':matches(code, pre)'
+      - 'code'
+      - 'pre'
+      - 'blockquote'
+  sources:
+  - '*.md'
+  - 'docs/**/*.md'

.wordlist.txt

@@ -0,0 +1,9 @@
+HPCPY
+HPC
+hpcpy
+pre
+py
+jobscript
+Jinja
+README
+md