Skip to content

Commit ce4c89b

Browse files
committed
feat: Add GitHub Actions workflow for previewing documentation
1 parent b0e2b09 commit ce4c89b

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/workflows/docs_preview.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Docs Preview
2+
3+
permissions:
4+
pull-requests: write
5+
6+
on:
7+
pull_request:
8+
types:
9+
- opened
10+
- synchronize
11+
- reopened
12+
- edited
13+
- closed
14+
paths:
15+
- "docs/**"
16+
- "fortls/interface.py"
17+
workflow_dispatch:
18+
19+
concurrency: preview-${{github.ref}}
20+
21+
jobs:
22+
deploy-preview:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- uses: actions/checkout@v4
26+
- uses: sphinx-toolbox/sphinx-action@master
27+
with:
28+
pre-build-command: "pip install .[docs]"
29+
docs-folder: "docs/"
30+
- name: Deploy Preview
31+
uses: rossjrw/[email protected]
32+
with:
33+
source-dir: docs/_build/html
34+
preview-branch: gh-pages

0 commit comments

Comments
 (0)