From 8e84e9a6471f3d61f9cea85d99309cbe434c92f3 Mon Sep 17 00:00:00 2001 From: jlzhou Date: Sun, 9 Nov 2025 23:20:13 +0800 Subject: [PATCH 1/3] ci: remove workingdir --- .github/workflows/deploy-docs.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 2587b8a..e00a1f3 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -13,9 +13,6 @@ jobs: runs-on: ubuntu-latest permissions: contents: write - defaults: - run: - working-directory: ./docs steps: - uses: actions/checkout@v5 From 31c895f8bfbf79c220f2c21169c2417f718ebace Mon Sep 17 00:00:00 2001 From: jlzhou Date: Sun, 9 Nov 2025 23:22:18 +0800 Subject: [PATCH 2/3] ci: add github actions to build docs This workflow automatically builds the documentation on each PR to verify that it remains buildable. --- .github/workflows/build-docs.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 0000000..e4c0ecb --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,28 @@ +name: Build Documents + +on: + pull_request: + types: + - opened + - synchronize + paths: + - ".github/workflows/build-docs.yml" + - "docs/**" + workflow_dispatch: # Allows to trigger the workflow manually in GitHub UI + +jobs: + run: + name: "build docs" + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v5 + with: + # See + fetch-depth: 0 + persist-credentials: false + + - name: Build HTML + uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" From ef287f99169f9233c41d9c076c956368b11a75b1 Mon Sep 17 00:00:00 2001 From: jlzhou Date: Sun, 9 Nov 2025 23:28:28 +0800 Subject: [PATCH 3/3] ci: pin sphinx version --- .github/workflows/build-docs.yml | 2 +- .github/workflows/deploy-docs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index e4c0ecb..a21bf35 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -23,6 +23,6 @@ jobs: persist-credentials: false - name: Build HTML - uses: ammaraskar/sphinx-action@master + uses: ammaraskar/sphinx-action@8.2.3 with: docs-folder: "docs/" diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index e00a1f3..568985e 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -22,7 +22,7 @@ jobs: persist-credentials: false - name: Build HTML - uses: ammaraskar/sphinx-action@master + uses: ammaraskar/sphinx-action@8.2.3 with: docs-folder: "docs/"