Skip to content

Commit 2f946c3

Browse files
Add hidden files
1 parent a86b05c commit 2f946c3

File tree

4 files changed

+123
-0
lines changed

4 files changed

+123
-0
lines changed

.github/workflows/accessibility.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
name: Accessibility check (Pa11y)
3+
4+
on:
5+
pull_request:
6+
branches: [ "main" ]
7+
workflow_dispatch:
8+
9+
jobs:
10+
pa11y:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- uses: actions/setup-node@v4
16+
with:
17+
node-version: '20'
18+
19+
- name: Install pa11y
20+
run: npm install -g pa11y pa11y-ci
21+
22+
- name: Build site
23+
uses: actions/setup-python@v5
24+
with:
25+
python-version: '3.11'
26+
- run: |
27+
python -m pip install --upgrade pip
28+
pip install -r requirements.in
29+
jupyter-book build .
30+
31+
- name: Run pa11y-ci on homepage
32+
run: |
33+
# Check the built homepage for common accessibility issues
34+
pa11y-ci --sitemap false "_build/html/index.html" || true

.github/workflows/build-book.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
name: Build Jupyter Book (PR check)
3+
4+
on:
5+
pull_request:
6+
branches: [ "main" ]
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-python@v5
15+
with:
16+
python-version: '3.11'
17+
- name: Install dependencies
18+
run: |
19+
python -m pip install --upgrade pip
20+
pip install -r requirements.in
21+
- name: Build Jupyter Book
22+
run: jupyter-book build .

.github/workflows/deploy-book.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
2+
name: Deploy Jupyter Book to GitHub Pages
3+
4+
on:
5+
push:
6+
branches: [ "main" ]
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: true
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: '3.11'
29+
30+
- name: Install dependencies
31+
run: |
32+
python -m pip install --upgrade pip
33+
pip install -r requirements.in
34+
35+
- name: Build Jupyter Book
36+
run: |
37+
jupyter-book build .
38+
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: _build/html
43+
44+
deploy:
45+
needs: build
46+
runs-on: ubuntu-latest
47+
environment:
48+
name: github-pages
49+
url: ${{ steps.deployment.outputs.page_url }}
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# Jupyter Book build artifacts
3+
_build/
4+
.jupyter_cache/
5+
6+
# Jupyter
7+
.ipynb_checkpoints/
8+
9+
# Python
10+
__pycache__/
11+
*.pyc
12+
13+
# OS
14+
.DS_Store

0 commit comments

Comments
 (0)