Skip to content

Commit 5aec735

Browse files
committed
Add technical documentation
1 parent ede1ceb commit 5aec735

File tree

1 file changed

+33
-14
lines changed

1 file changed

+33
-14
lines changed

.github/.workflow/deploy.yml

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,50 @@
1-
name: Deploy Jupyter Book
1+
name: Deploy Jupyter Book to GitHub Pages
22

33
on:
44
push:
5-
branches:
6-
- main
7-
- master
5+
branches: [ master ]
86

97
permissions:
10-
contents: write
8+
contents: read
119
pages: write
1210
id-token: write
1311

12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
15+
1416
jobs:
15-
build:
17+
deploy:
18+
environment:
19+
name: github-pages
20+
url: ${{ steps.deployment.outputs.page_url }}
1621
runs-on: ubuntu-latest
1722

1823
steps:
19-
- uses: actions/checkout@v3
24+
- uses: actions/checkout@v4
25+
26+
- name: Setup Pages
27+
uses: actions/configure-pages@v5
2028

21-
- name: Install Jupyter Book
22-
run: pip install jupyter-book
29+
- name: Setup Python
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: '3.11'
2333

24-
- name: Build book
34+
- name: Install dependencies
35+
run: |
36+
python -m pip install --upgrade pip
37+
pip install 'jupyter-book<2.0'
38+
pip install pandas plotly matplotlib
39+
40+
- name: Build Jupyter Book
2541
run: jupyter-book build .
2642

27-
- name: Deploy
28-
uses: peaceiris/actions-gh-pages@v3
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
2945
with:
30-
github_token: ${{ secrets.GITHUB_TOKEN }}
31-
publish_dir: ./_build/html
46+
path: _build/html
47+
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)