Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/mkdocs/mkdocs/issues/2370#issuecomment-821926264>
fetch-depth: 0
persist-credentials: false

- name: Build HTML
uses: ammaraskar/sphinx-action@8.2.3
with:
docs-folder: "docs/"
5 changes: 1 addition & 4 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@ jobs:
runs-on: ubuntu-latest
permissions:
contents: write
defaults:
run:
working-directory: ./docs

steps:
- uses: actions/checkout@v5
Expand All @@ -25,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/"

Expand Down
Loading