From dbb0fbddf140a09b79e168d484f44fe5a406419a Mon Sep 17 00:00:00 2001 From: Anthony Agelastos Date: Tue, 6 Jan 2026 09:42:00 -0700 Subject: [PATCH 1/6] Switched Sphinx building to use build_doc.py wrapper script and enhanced the script to specify the same WORKSPACE_PATH as was previously set up. --- .github/workflows/docs.yml | 3 ++- docs/build_doc.py | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index aa226f4..3f54bda 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -30,7 +30,8 @@ jobs: - name: Build with sphinx run: | cd docs - make html WORKSPACE_PATH=/tmp/workspace + # make html WORKSPACE_PATH=/tmp/workspace + ./build_doc.py --html - name: Check for Typos using Codespell run: | diff --git a/docs/build_doc.py b/docs/build_doc.py index 0822a65..de067ac 100755 --- a/docs/build_doc.py +++ b/docs/build_doc.py @@ -307,7 +307,7 @@ def _build_pdf(self): self.logger.info("Building PDF...") run_app(self.logger, ["sphinx-build", "-b", "latex", ".", "_build"]) - run_app(self.logger, ["make", "latexpdf"]) + run_app(self.logger, ["make", "latexpdf", "WORKSPACE_PATH=/tmp/workspace"]) def _build_html(self): """This builds the documentation with exporting to HTML.""" @@ -317,7 +317,7 @@ def _build_html(self): self.logger.info("Building HTML...") run_app(self.logger, ["sphinx-build", "-b", "html", ".", "_build"]) - run_app(self.logger, ["make", "html"]) + run_app(self.logger, ["make", "html", "WORKSPACE_PATH=/tmp/workspace"]) def build_doc(self): """This builds the documentation.""" From fdb91e2f448a6245bc57d4cdd61435dcb0b895c0 Mon Sep 17 00:00:00 2001 From: Anthony Agelastos Date: Tue, 6 Jan 2026 17:37:17 -0700 Subject: [PATCH 2/6] Added gnuplot and matplotlib installation --- .github/workflows/docs.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3f54bda..c3dda79 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,6 +19,11 @@ jobs: cache: 'pip' cache-dependency-path: '.github/workflows/requirements/docs.txt' + - name: Install Matplotlib + run: + python -m pip install --upgrade pip + pip install matplotlib + - name: Setup GitHub Pages id: pages uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b @@ -27,6 +32,10 @@ jobs: run: | pip install -r .github/workflows/requirements/docs.txt + - name: Install Gnuplot + run: | + apt install -y gnuplot + - name: Build with sphinx run: | cd docs From 0ca2ab8154cd52b05f69c94a340c141df1cb6e45 Mon Sep 17 00:00:00 2001 From: Anthony Agelastos Date: Mon, 2 Feb 2026 14:21:29 -0700 Subject: [PATCH 3/6] Changed GitHub Action to skip an installation via pip if it is already installed (matplotlib) --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c3dda79..ef74240 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,7 +22,7 @@ jobs: - name: Install Matplotlib run: python -m pip install --upgrade pip - pip install matplotlib + pip install --ignore-installed matplotlib - name: Setup GitHub Pages id: pages From 4da2e35e29ee04cb75ef6471c51e5fa241f54214 Mon Sep 17 00:00:00 2001 From: Anthony Agelastos Date: Mon, 2 Feb 2026 17:08:24 -0700 Subject: [PATCH 4/6] added matplotlib as a requirement for the docs.txt Python setup --- .github/workflows/docs.yml | 5 ----- .github/workflows/requirements/docs.txt | 1 + 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ef74240..cd6e127 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,11 +19,6 @@ jobs: cache: 'pip' cache-dependency-path: '.github/workflows/requirements/docs.txt' - - name: Install Matplotlib - run: - python -m pip install --upgrade pip - pip install --ignore-installed matplotlib - - name: Setup GitHub Pages id: pages uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b diff --git a/.github/workflows/requirements/docs.txt b/.github/workflows/requirements/docs.txt index f49db21..05275ca 100644 --- a/.github/workflows/requirements/docs.txt +++ b/.github/workflows/requirements/docs.txt @@ -20,3 +20,4 @@ pyarrow==3.0.0;python_version<="3.6" google-cloud-bigquery tqdm deprecation +matplotlib From 5145499e04a9b6eb7204d2f4227d6e0a9b122896 Mon Sep 17 00:00:00 2001 From: Anthony Agelastos Date: Mon, 2 Feb 2026 17:10:11 -0700 Subject: [PATCH 5/6] force apt install to be run via sudo --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index cd6e127..9350a78 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -29,7 +29,7 @@ jobs: - name: Install Gnuplot run: | - apt install -y gnuplot + sudo apt install -y gnuplot - name: Build with sphinx run: | From 94824ab03b03f5a3759cfd88ff4ea76d9be8bbeb Mon Sep 17 00:00:00 2001 From: Anthony Agelastos Date: Mon, 2 Feb 2026 17:13:47 -0700 Subject: [PATCH 6/6] Add a repository update command so downstream installations are grabbing recent changes --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9350a78..696b091 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -29,6 +29,7 @@ jobs: - name: Install Gnuplot run: | + sudo apt update sudo apt install -y gnuplot - name: Build with sphinx