SPM-Python

.github/workflows/linkcheck.yml

@@ -11,12 +11,29 @@ jobs:
   check-links:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      - uses: actions/checkout@v4
+      - uses: tcort/github-action-markdown-link-check@v1
+        # This step does not check doi.org links
         with:
           use-quiet-mode: 'yes'
           use-verbose-mode: 'no'
           config-file: '.markdown-link-check.json'
           folder-path: 'docs/installation, docs/tutorials'
           file-path: './README.md, ./docs/index.md'
           base-branch: main
+      - uses: tcort/github-action-markdown-link-check@v1
+        # This step only checks doi.org links
+        # -> for doi.org links, if the doi does not exist, 404 is returned
+        #    otherwise, it redirects to the publisher website, so any
+        #    code that is not 404 is a "success".
+        # We do this because some publisher websites (e.g. wiley) are
+        # peaky and return 403 when the website is not accessed from a
+        # proper browser.
+        if: always()
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'no'
+          config-file: '.markdown-link-check-doi.json'
+          folder-path: 'docs/installation, docs/tutorials'
+          file-path: './README.md, ./docs/index.md'
+          base-branch: main

.markdown-link-check-doi.json

@@ -0,0 +1,8 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^(?!https?://doi.org)"
+    }
+  ],
+  "aliveStatusCodes": [200,206,403,503]
+}

.markdown-link-check.json

@@ -2,6 +2,9 @@
   "ignorePatterns": [
     {
       "pattern": "^(?!http)"
+    },
+    {
+      "pattern": "^https?://doi.org"
     }
   ],
   "aliveStatusCodes": [200,206,503],

docs/assets/css/extra.css

@@ -1,7 +1,45 @@
 .md-typese__table {
     min-width: 100%;
 }
- 
+
 .md-typeset table:not([class]) {
      display: table;
-}
+}
+
+/* Admonition Matlab */
+:root {
+  --md-admonition-icon--matlab: url('data:image/svg+xml,%3C%3Fxml%20version%3D%221.0%22%20encoding%3D%22utf-8%22%3F%3E%3C!--%20Uploaded%20to%3A%20SVG%20Repo%2C%20www.svgrepo.com%2C%20Generator%3A%20SVG%20Repo%20Mixer%20Tools%20--%3E%3Csvg%20width%3D%22800px%22%20height%3D%22800px%22%20viewBox%3D%220%200%2032%2032%22%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20xmlns%3Axlink%3D%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxlink%22%3E%3Cdefs%3E%3ClinearGradient%20id%3D%22a%22%20x1%3D%2216.803%22%20y1%3D%2216.631%22%20x2%3D%2215.013%22%20y2%3D%2222.411%22%20gradientTransform%3D%22matrix(1%2C%200%2C%200%2C%20-1%2C%200%2C%2032)%22%20gradientUnits%3D%22userSpaceOnUse%22%3E%3Cstop%20offset%3D%220%22%20stop-color%3D%22%23512%22%2F%3E%3Cstop%20offset%3D%220.23%22%20stop-color%3D%22%23523%22%2F%3E%3Cstop%20offset%3D%220.36%22%20stop-color%3D%22%23534%22%2F%3E%3Cstop%20offset%3D%220.51%22%20stop-color%3D%22%23645%22%2F%3E%3Cstop%20offset%3D%220.66%22%20stop-color%3D%22%23568%22%2F%3E%3Cstop%20offset%3D%220.84%22%20stop-color%3D%22%2329d%22%2F%3E%3C%2FlinearGradient%3E%3ClinearGradient%20id%3D%22b%22%20x1%3D%2229.71%22%20y1%3D%2218.983%22%20x2%3D%2211.71%22%20y2%3D%2214.563%22%20gradientUnits%3D%22userSpaceOnUse%22%3E%3Cstop%20offset%3D%220.081%22%20stop-color%3D%22%23c33%22%2F%3E%3Cstop%20offset%3D%220.189%22%20stop-color%3D%22%23de5239%22%2F%3E%3Cstop%20offset%3D%220.313%22%20stop-color%3D%22%23f06e3e%22%2F%3E%3Cstop%20offset%3D%220.421%22%20stop-color%3D%22%23fa8042%22%2F%3E%3Cstop%20offset%3D%220.5%22%20stop-color%3D%22%23fe8643%22%2F%3E%3Cstop%20offset%3D%220.58%22%20stop-color%3D%22%23fa7f42%22%2F%3E%3Cstop%20offset%3D%220.696%22%20stop-color%3D%22%23ef6c3e%22%2F%3E%3Cstop%20offset%3D%220.833%22%20stop-color%3D%22%23dc4c37%22%2F%3E%3Cstop%20offset%3D%220.916%22%20stop-color%3D%22%23cf3633%22%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Ctitle%3Efile_type_matlab%3C%2Ftitle%3E%3Cpath%20d%3D%22M2%2C17.55l7.97-3.22a20.7%2C20.7%2C0%2C0%2C1%2C2.72-2.95c.66-.35%2C1.9-.16%2C4.17-2.98%2C2.2-2.75%2C2.9-5.1%2C3.93-5.1%2C1.63%2C0%2C2.83%2C3.52%2C4.65%2C8.85A115.629%2C115.629%2C0%2C0%2C0%2C30%2C24.12c-1.9-1.77-3.52-3.68-5.37-3.63-1.72.04-3.63%2C2.08-5.72%2C4.7-1.66%2C2.1-3.86%2C3.54-4.72%2C3.51%2C0%2C0-2.22-6.28-4.08-7.3a2.641%2C2.641%2C0%2C0%2C0-2.39.2L2%2C17.54Z%22%20style%3D%22fill%3A%2349d%22%2F%3E%3Cpath%20d%3D%22M19.8%2C4.02c-.67.9-1.48%2C2.55-2.94%2C4.38-2.27%2C2.82-3.5%2C2.63-4.17%2C2.98a19.674%2C19.674%2C0%2C0%2C0-2.72%2C2.95l3.3%2C2.41c2.8-3.82%2C4.3-7.96%2C5.47-10.64A13.579%2C13.579%2C0%2C0%2C1%2C19.8%2C4.02Z%22%20style%3D%22fill%3Aurl(%23a)%22%2F%3E%3Cpath%20d%3D%22M20.8%2C3.3c-2.18%2C0-3.67%2C11.48-11.72%2C17.89%2C2.26-.37%2C4.22%2C5.24%2C5.12%2C7.51%2C4-.68%2C7.2-8.33%2C10.43-8.21%2C1.85.07%2C3.47%2C1.86%2C5.37%2C3.63C25.66%2C15%2C23.63%2C3.3%2C20.8%2C3.3Z%22%20style%3D%22fill%3Aurl(%23b)%22%2F%3E%3C%2Fsvg%3E')
+}
+.md-typeset .admonition.matlab,
+.md-typeset details.matlab {
+  border-color: rgb(255, 165, 0);
+}
+.md-typeset .matlab > .admonition-title,
+.md-typeset .matlab > summary {
+  background-color: rgba(255, 165, 0, 0.1);
+}
+.md-typeset .matlab > .admonition-title::before,
+.md-typeset .matlab > summary::before {
+  background-color: rgb(255, 165, 0);
+  -webkit-mask-image: var(--md-admonition-icon--matlab);
+          mask-image: var(--md-admonition-icon--matlab);
+}
+
+/* Admonition Python */
+:root {
+  --md-admonition-icon--python: url('https://upload.wikimedia.org/wikipedia/commons/c/c3/Python-logo-notext.svg')
+}
+.md-typeset .admonition.python,
+.md-typeset details.python {
+  border-color: rgb(84, 129, 176);
+}
+.md-typeset .python > .admonition-title,
+.md-typeset .python > summary {
+  background-color: rgba(84, 129, 176, 0.1);
+}
+.md-typeset .python > .admonition-title::before,
+.md-typeset .python > summary::before {
+  background-color: rgb(84, 129, 176);
+  -webkit-mask-image: var(--md-admonition-icon--python);
+          mask-image: var(--md-admonition-icon--python);
+}