Merge pull request #296 from jorenham/repo-review

Repo-review

.github/workflows/ci.yml

@@ -24,6 +24,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - uses: scientific-python/repo-review@v0.11.1
+        with:
+          plugins: sp-repo-review
+
       - name: install poetry
         run: |
           pipx install poetry
@@ -53,11 +57,6 @@ jobs:
       - name: basedpyright --verifytypes
         run: poetry run basedpyright --ignoreexternal --verifytypes optype
 
-      # TODO:
-      # - uses: scientific-python/repo-review@v0.11.0
-      #   with:
-      #     plugins: sp-repo-review
-
   test:
     timeout-minutes: 20
 

.markdownlint.yaml

@@ -4,10 +4,10 @@ MD007:
   indent: 4
 MD033:
   allowed_elements:
-    - 'br'
-    - 'table'
-    - 'tr'
-    - 'th'
-    - 'td'
-    - 'img'
+    - "br"
+    - "table"
+    - "tr"
+    - "th"
+    - "td"
+    - "img"
 MD041: false

.pre-commit-config.yaml

@@ -41,6 +41,19 @@ repos:
         args: [--markdown-linebreak-ext=md]
         exclude_types: [svg]
 
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: "v3.3.3"
+    hooks:
+      - id: prettier
+        types_or: [yaml, html, css, scss, javascript, json]
+
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.41.0
     hooks:

.vscode/extensions.json

@@ -1,11 +1,14 @@
 {
-  "recommendations": [
-    "charliermarsh.ruff",
-    "codezombiech.gitignore",
-    "davidanson.vscode-markdownlint",
-    "detachhead.basedpyright",
-    "editorconfig.editorconfig",
-    "ms-python.python"
-  ],
-  "unwantedRecommendations": ["ms-pyright.pyright", "ms-python.vscode-pylance"]
+    "recommendations": [
+        "charliermarsh.ruff",
+        "codezombiech.gitignore",
+        "davidanson.vscode-markdownlint",
+        "detachhead.basedpyright",
+        "editorconfig.editorconfig",
+        "ms-python.python"
+    ],
+    "unwantedRecommendations": [
+        "ms-pyright.pyright",
+        "ms-python.vscode-pylance"
+    ]
 }

docs/scripts/katex.js

@@ -5,10 +5,10 @@ document$.subscribe(({ body }) => {
         throwOnError: true,
         trust: true,
         delimiters: [
-            {left: "$$", right: "$$", display: true},
-            {left: "$", right: "$", display: false},
-            {left: "\\(", right: "\\)", display: false},
-            {left: "\\[", right: "\\]", display: true},
+            { left: "$$", right: "$$", display: true },
+            { left: "$", right: "$", display: false },
+            { left: "\\(", right: "\\)", display: false },
+            { left: "\\[", right: "\\]", display: true },
         ],
         macros: {
             // Statistical operators
@@ -50,6 +50,6 @@ document$.subscribe(({ body }) => {
 
             // some missing "physics" tex package commands
             "\\dd": "\\,\\mathrm{d}{#1}",
-        }
-    })
-})
+        },
+    });
+});

docs/styles/theme.css

@@ -5,27 +5,27 @@
 [data-md-color-primary="nose"] {
     --md-primary-fg-color: rgb(149, 149, 47);
     --md-primary-fg-color--light: rgb(199, 199, 59);
-    --md-primary-fg-color--dark: rgb(99, 99,31);
+    --md-primary-fg-color--dark: rgb(99, 99, 31);
 }
 [data-md-color-accent="skin"] {
     --md-accent-fg-color: rgba(223, 71, 71, 1);
     --md-accent-fg-color--light: rgba(255, 95, 95, 1);
     --md-accent-fg-color--dark: rgba(191, 47, 47, 1);
-    --md-accent-bg-color: rgba( 33, 37, 41, 1);
-    --md-accent-bg-color--light: rgba( 33, 37, 41, .8);
+    --md-accent-bg-color: rgba(33, 37, 41, 1);
+    --md-accent-bg-color--light: rgba(33, 37, 41, 0.8);
 }
 
 /* https://mkdocstrings.github.io/python/usage/customization/#material */
 div.doc-contents:not(.first) {
     padding-left: 25px;
-    border-left: .05rem solid var(--md-typeset-table-color);
+    border-left: 0.05rem solid var(--md-typeset-table-color);
 }
 a.external::after,
 a.autorefs-external::after {
     /* https://primer.style/octicons/arrow-up-right-24 */
     mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
     -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
-    content: ' ';
+    content: " ";
 
     display: inline-block;
     vertical-align: middle;