Skip to content

Commit 782f2f6

Browse files
committed
adding deploy-docs.yml
1 parent 87eccc5 commit 782f2f6

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy Documentation to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ "formatting-changes" ]
6+
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v4
27+
with:
28+
python-version: '3.12'
29+
30+
- name: Install Hatch
31+
run: pip install hatch
32+
33+
- name: Install dependencies
34+
run: |
35+
cd powersensor_local # Replace with your actual package name
36+
pip install -e ".[docs]"
37+
38+
- name: Build documentation
39+
run: |
40+
cd powersensor_local/docs # Replace with your actual package name
41+
make html
42+
43+
- name: Setup Pages
44+
uses: actions/configure-pages@v4
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v2
48+
with:
49+
path: 'powersensor_local/docs/build/html'
50+
51+
deploy:
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
runs-on: ubuntu-latest
56+
needs: build
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v3

0 commit comments

Comments
 (0)