From 51c4de7663fcb2dba70650159552eb044d28bdef Mon Sep 17 00:00:00 2001 From: Jacob Watters <47160062+jacobdwatters@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:32:57 -0700 Subject: [PATCH 1/6] Update javadoc-gh-pages.yml Inject MathJax into Javadoc during deployment --- .github/workflows/javadoc-gh-pages.yml | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/workflows/javadoc-gh-pages.yml b/.github/workflows/javadoc-gh-pages.yml index 9527d03f3..b6a893c01 100644 --- a/.github/workflows/javadoc-gh-pages.yml +++ b/.github/workflows/javadoc-gh-pages.yml @@ -18,19 +18,22 @@ jobs: java-version: 23 - name: Build Javadoc + # Generate javadoc and inject MathJax in a very cheeky way. run: | mvn clean install mvn javadoc:javadoc \ -Dmaven.javadoc.failOnError=false \ - -Dmaven.javadoc.skip=false - - - name: Inject MathJax script - # Adjust path to where your Javadoc output is actually generated - run: | - find target/reports/apidocs -type f -name "*.html" -exec \ - sed -i '/<\/head>/i ' {} + + -Dmaven.javadoc.skip=false \ + -header "" + + # - name: Inject MathJax script + # # Adjust path to where your Javadoc output is actually generated + # run: | + # find target/reports/apidocs -type f -name "*.html" -exec \ + # sed -i '/<\/head>/i ' {} + - name: Upload Pages Artifact # This action collects the directory containing docs @@ -41,7 +44,7 @@ jobs: # Adjust path to match your actual Javadoc output path: target/reports/apidocs - # --- 2) Deploy the artifact to GitHub Pages + # 2) Deploy the artifact to GitHub Pages deploy-docs: needs: build-docs runs-on: ubuntu-latest From 83ab1bc7f70fd38ec6f0c0566dc3e4fa69270e2a Mon Sep 17 00:00:00 2001 From: Jacob Watters <47160062+jacobdwatters@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:42:08 -0700 Subject: [PATCH 2/6] Update javadoc-gh-pages.yml --- .github/workflows/javadoc-gh-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/javadoc-gh-pages.yml b/.github/workflows/javadoc-gh-pages.yml index b6a893c01..697767c20 100644 --- a/.github/workflows/javadoc-gh-pages.yml +++ b/.github/workflows/javadoc-gh-pages.yml @@ -25,7 +25,7 @@ jobs: -Dmaven.javadoc.failOnError=false \ -Dmaven.javadoc.skip=false \ -header "" + src=\"https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\">" # - name: Inject MathJax script # # Adjust path to where your Javadoc output is actually generated From 1b7904f73865d45308685443fbf3f71b2cb7e366 Mon Sep 17 00:00:00 2001 From: Jacob Watters <47160062+jacobdwatters@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:43:53 -0700 Subject: [PATCH 3/6] Update javadoc-gh-pages.yml --- .github/workflows/javadoc-gh-pages.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/javadoc-gh-pages.yml b/.github/workflows/javadoc-gh-pages.yml index 697767c20..2fe01b5dc 100644 --- a/.github/workflows/javadoc-gh-pages.yml +++ b/.github/workflows/javadoc-gh-pages.yml @@ -24,8 +24,8 @@ jobs: mvn javadoc:javadoc \ -Dmaven.javadoc.failOnError=false \ -Dmaven.javadoc.skip=false \ - -header "" + -header "" # - name: Inject MathJax script # # Adjust path to where your Javadoc output is actually generated From c69f9b13f98b3ba778bd690fc9fdd93a5462c8cb Mon Sep 17 00:00:00 2001 From: Jacob Watters <47160062+jacobdwatters@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:47:01 -0700 Subject: [PATCH 4/6] Update javadoc-gh-pages.yml --- .github/workflows/javadoc-gh-pages.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/javadoc-gh-pages.yml b/.github/workflows/javadoc-gh-pages.yml index 2fe01b5dc..9367dad70 100644 --- a/.github/workflows/javadoc-gh-pages.yml +++ b/.github/workflows/javadoc-gh-pages.yml @@ -24,8 +24,7 @@ jobs: mvn javadoc:javadoc \ -Dmaven.javadoc.failOnError=false \ -Dmaven.javadoc.skip=false \ - -header "" + -header "" # - name: Inject MathJax script # # Adjust path to where your Javadoc output is actually generated From 9ccd77882effca096fb9a43170892c5a8171cc67 Mon Sep 17 00:00:00 2001 From: Jacob Watters <47160062+jacobdwatters@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:48:21 -0700 Subject: [PATCH 5/6] Update javadoc-gh-pages.yml --- .github/workflows/javadoc-gh-pages.yml | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/workflows/javadoc-gh-pages.yml b/.github/workflows/javadoc-gh-pages.yml index 9367dad70..330266211 100644 --- a/.github/workflows/javadoc-gh-pages.yml +++ b/.github/workflows/javadoc-gh-pages.yml @@ -23,16 +23,14 @@ jobs: mvn clean install mvn javadoc:javadoc \ -Dmaven.javadoc.failOnError=false \ - -Dmaven.javadoc.skip=false \ - -header "" + -Dmaven.javadoc.skip=false - # - name: Inject MathJax script - # # Adjust path to where your Javadoc output is actually generated - # run: | - # find target/reports/apidocs -type f -name "*.html" -exec \ - # sed -i '/<\/head>/i ' {} + + - name: Inject MathJax script + run: | + find target/reports/apidocs -type f -name "*.html" -exec \ + sed -i '/<\/head>/i ' {} + - name: Upload Pages Artifact # This action collects the directory containing docs From 654392997d59448074f201a5c88b65f6222d94bd Mon Sep 17 00:00:00 2001 From: Jacob Watters <47160062+jacobdwatters@users.noreply.github.com> Date: Thu, 13 Feb 2025 21:23:45 -0700 Subject: [PATCH 6/6] Disable MathJax in Javadoc for now --- .github/workflows/javadoc-gh-pages.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/javadoc-gh-pages.yml b/.github/workflows/javadoc-gh-pages.yml index 330266211..94adc5a75 100644 --- a/.github/workflows/javadoc-gh-pages.yml +++ b/.github/workflows/javadoc-gh-pages.yml @@ -18,19 +18,19 @@ jobs: java-version: 23 - name: Build Javadoc - # Generate javadoc and inject MathJax in a very cheeky way. run: | mvn clean install mvn javadoc:javadoc \ -Dmaven.javadoc.failOnError=false \ -Dmaven.javadoc.skip=false - - name: Inject MathJax script - run: | - find target/reports/apidocs -type f -name "*.html" -exec \ - sed -i '/<\/head>/i ' {} + + # - name: Inject MathJax script + # # inject MathJax for rendering + # run: | + # find target/reports/apidocs -type f -name "*.html" -exec \ + # sed -i '/<\/head>/i ' {} + - name: Upload Pages Artifact # This action collects the directory containing docs