From 789e3b558389490fd133853a43032f1922654147 Mon Sep 17 00:00:00 2001 From: soot-bit <03peng@gmail.com> Date: Wed, 30 Apr 2025 20:52:00 +0200 Subject: [PATCH 1/4] Fix documentation build: GitHub Actions, Sphinx 5.3.0, and theme compatibility --- .github/workflows/doc-build.yml | 3 ++- docs/source/_static/.gitkeep | 0 docs/source/conf.py | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 docs/source/_static/.gitkeep diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 5836da1c15..64ddbf7e41 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -22,7 +22,7 @@ jobs: run: | export DEBIAN_FRONTEND=noninteractive sudo apt-get update - sudo apt install -y git python3-venv make + sudo apt install -y git python3-venv make python3-setuptools echo `python3 --version` python3 -m venv venv source venv/bin/activate @@ -30,6 +30,7 @@ jobs: id: build - name: Build the docset run: | + source ../venv/bin/activate cd docs pip install -r requirements.txt make html diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/source/conf.py b/docs/source/conf.py index acf3230d7d..03b7dbe541 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -41,8 +41,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.napoleon", "sphinx.ext.autodoc", 'sphinx_panels'] -panels_add_bootstrap_css = False +extensions = ["sphinx.ext.napoleon", "sphinx.ext.autodoc", "sphinx_panels"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -66,6 +65,7 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +html_css_files = [] # avoid undefined errors panels_add_fontawesome_latex = True html_theme_options = { From 1fb774d03ad9605bfc2034a73815558786754247 Mon Sep 17 00:00:00 2001 From: soot-bit <03peng@gmail.com> Date: Fri, 2 May 2025 22:55:03 +0200 Subject: [PATCH 2/4] simplified workflow and remove redundant configs --- .github/workflows/doc-build.yml | 9 --------- docs/source/conf.py | 2 +- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 64ddbf7e41..724cf04e93 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -18,15 +18,6 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 - - name: Dependencies - run: | - export DEBIAN_FRONTEND=noninteractive - sudo apt-get update - sudo apt install -y git python3-venv make python3-setuptools - echo `python3 --version` - python3 -m venv venv - source venv/bin/activate - pip install --upgrade pip setuptools id: build - name: Build the docset run: | diff --git a/docs/source/conf.py b/docs/source/conf.py index 03b7dbe541..c16735c281 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -65,7 +65,7 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] -html_css_files = [] # avoid undefined errors + panels_add_fontawesome_latex = True html_theme_options = { From 53f9cb7fce0da08031a63d2dcef885d51d1f2400 Mon Sep 17 00:00:00 2001 From: soot-bit <03peng@gmail.com> Date: Fri, 2 May 2025 23:24:49 +0200 Subject: [PATCH 3/4] removed venv activation line --- .github/workflows/doc-build.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 724cf04e93..616873f56a 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -21,7 +21,6 @@ jobs: id: build - name: Build the docset run: | - source ../venv/bin/activate cd docs pip install -r requirements.txt make html From ee68721d9933be0b2f330f3ea4b9a24702b58a57 Mon Sep 17 00:00:00 2001 From: soot-bit <03peng@gmail.com> Date: Fri, 2 May 2025 23:30:08 +0200 Subject: [PATCH 4/4] removed unnecessary line --- docs/source/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index c16735c281..47a4e80774 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -65,7 +65,6 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] - panels_add_fontawesome_latex = True html_theme_options = {