Skip to content

Commit cd9482b

Browse files
author
Icíar Lloréns Jover
committed
Add workflow to build and deploy documentation
1 parent a5fe9b8 commit cd9482b

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# This workflow will build and publish the documentation to the `gh-pages` branch of the
2+
# repository when a new tag is added.
3+
# It uses the `peaceiris/actions-gh-pages` action to handle the publishing.
4+
#
5+
# Copyright (c) 2025 MeteoSwiss, based on the workflow created by Michele Cattaneo; michele.cattaneo@meteoswiss.ch
6+
7+
name: docs_publish
8+
9+
on:
10+
push:
11+
branches: ['main']
12+
13+
jobs:
14+
15+
docs:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout current repository
20+
uses: actions/checkout@v4
21+
22+
- name: Set up Python 3.12
23+
uses: actions/setup-python@v5
24+
with:
25+
python-version: 3.12
26+
27+
- name: Install poetry and python package
28+
run: |
29+
python -m pip install --upgrade pip
30+
python -m pip install poetry
31+
poetry install
32+
33+
- name: Build documentation
34+
run: poetry run sphinx-build doc doc/_build
35+
36+
- name: Publish documentation
37+
uses: peaceiris/actions-gh-pages@v3
38+
39+
with:
40+
publish_branch: gh-pages
41+
github_token: ${{ secrets.GITHUB_TOKEN }}
42+
publish_dir: doc/_build/
43+
force_orphan: true

0 commit comments

Comments
 (0)