add modded CSS from basic theme for footnotes/citations (#313)

* fix eslint errors in search.ts * fix CI not doing `npm run check` * use CSS grid
jbms · Mar 30, 2024 · 63a80bb · 63a80bb
1 parent d965e31
commit 63a80bb
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 15 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -19,11 +19,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        nox-sessions:
-          - 'black check_yaml check_json check_toml check_eof check_trailing_space check_lf'
-        python-version: ['3.x']
-        node-version: ['16.x']
         include:
+          - nox-sessions: 'black check_yaml check_json check_toml check_eof check_trailing_space check_lf'
+            python-version: '3.x'
+            node-version: '16.x'
           - nox-sessions: 'mypy pylint'
             python-version: '3.8'
           - nox-sessions: 'mypy pylint'
@@ -37,7 +36,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Setup Node.js
-        if: contains(matrix, 'node-version')
+        if: matrix.node-version
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
@@ -47,23 +46,23 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Cache node.js modules
-        if: contains(matrix, 'node-version')
+        if: matrix.node-version
         uses: actions/cache@v4
         with:
           path: "**/node_modules"
           key: ${{ runner.os }}-${{ matrix.node-version }}-node_modules-${{ hashFiles('**/package-lock.json') }}
       - name: Cache nox environments
-        if: contains(matrix, 'node-version')
         uses: actions/cache@v4
+        if: matrix.node-version
         with:
           path: |
             .nox/black
             .nox/check_*
           key: nox-${{ steps.python-setup.outputs.python-version }}-${{ hashFiles('requirements/dev-black.txt', 'requirements/dev-pre_commit_hooks.txt') }}
       - run: npm install
-        if: contains(matrix, 'node-version')
+        if: matrix.node-version
       - run: npm run check
-        if: contains(matrix, 'node-version')
+        if: matrix.node-version
       - run: pipx run nox -s ${{ matrix.nox-sessions }}
 
   build:

diff --git a/src/assets/javascripts/sphinx_search.ts b/src/assets/javascripts/sphinx_search.ts
@@ -710,12 +710,12 @@ export async function getResults(query: string): Promise<SearchResultStream> {
   const objectterms = []
 
   for (let origTerm of splitQuery(query)) {
-    let negative = false;
-    if (origTerm[0] === '-') {
-      negative = true;
-      origTerm = origTerm.substr(1);
+    let negative = false
+    if (origTerm[0] === "-") {
+      negative = true
+      origTerm = origTerm.substr(1)
     }
-    let lowerTerm = origTerm.toLowerCase()
+    const lowerTerm = origTerm.toLowerCase()
     if (lowerTerm.length === 0) {
       continue
     }
@@ -725,7 +725,7 @@ export async function getResults(query: string): Promise<SearchResultStream> {
     // by special characters like [-._].  Split them up and treat each
     // as a separate search term.
     for (const wordMatch of lowerTerm.matchAll(/\w+/g)) {
-      const subTerm = wordMatch[0];
+      const subTerm = wordMatch[0]
       if (stopwords.indexOf(subTerm) !== -1) {
         // skip this "word"
         continue

diff --git a/src/assets/stylesheets/main/_sphinx.scss b/src/assets/stylesheets/main/_sphinx.scss
@@ -96,4 +96,42 @@
   div.line-block div.line-block {
     margin-left: 1.5em;
   }
+
+  // display of footnotes and citations
+  aside.footnote,
+  div.citation {
+    display: grid;
+    grid-auto-columns: minmax(auto, max-content);
+
+    > span {
+      &.label {
+        grid-column: 1;
+      }
+
+      &.backrefs {
+        grid-column: 2;
+      }
+
+      &:last-of-type {
+        padding-right: 0.5em;
+      }
+    }
+
+    > :not(span.backrefs, span.label) {
+      grid-column: 3;
+
+      &:first-of-type {
+        margin-top: 0;
+      }
+
+      &:last-child {
+        margin-bottom: 0;
+
+        &::after {
+          clear: both;
+          content: "";
+        }
+      }
+    }
+  }
 }