Skip to content

Commit 08c1de9

Browse files
committed
Add GitHub pages build
1 parent 8ddf405 commit 08c1de9

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# SPDX-FileCopyrightText: 2025 Helmholtz-Zentrum Dresden - Rossendorf (HZDR)
2+
# SPDX-License-Identifier: CC0-1.0
3+
# SPDX-FileContributor: David Pape
4+
5+
name: documentation
6+
7+
on: [push, pull_request, workflow_dispatch]
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
docs:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: actions/setup-python@v5
18+
- name: Install Package
19+
run: |
20+
python -m pip install .[docs]
21+
- name: Build Documentation
22+
run: |
23+
task docs-build
24+
- name: Deploy to GitHub Pages Branch
25+
uses: peaceiris/actions-gh-pages@v4
26+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
27+
with:
28+
publish_branch: gh-pages
29+
github_token: ${{ secrets.GITHUB_TOKEN }}
30+
publish_dir: docs/_build/html/
31+
force_orphan: true

0 commit comments

Comments
 (0)