Skip to content

Commit c8860ee

Browse files
committed
chore(CI): add docs action
1 parent bca813d commit c8860ee

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
release:
7+
types: [released]
8+
pull_request:
9+
types: [opened, synchronize]
10+
11+
concurrency:
12+
# Cancel older, in-progress jobs from the same PR, same workflow.
13+
# use run_id if the job is triggered by a push to ensure
14+
# push-triggered jobs to not get canceled.
15+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
16+
cancel-in-progress: true
17+
18+
jobs:
19+
docs:
20+
runs-on: ubuntu-latest
21+
22+
permissions:
23+
contents: write
24+
25+
steps:
26+
- uses: actions/checkout@v4
27+
28+
- name: Setup Python
29+
uses: actions/setup-python@v5
30+
with:
31+
python-version: "3.10"
32+
33+
- name: Install Dependencies
34+
run: |
35+
python -m pip install --upgrade pip
36+
pip install .[docs]
37+
38+
- name: Ape Docs
39+
uses: apeworx/sphinx-ape@main
40+
with:
41+
github-token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)