Skip to content

Commit 747927b

Browse files
authored
Deploy Docs to GitHub Pages (#65)
1 parent 22182ec commit 747927b

File tree

2 files changed

+51
-2
lines changed

2 files changed

+51
-2
lines changed

.github/workflows/build.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
token: ${{ secrets.GITHUB_TOKEN }}
3030
- uses: actions/setup-python@v4
3131
with:
32-
python-version: '3.10'
32+
python-version: '3.11'
3333
- name: Install ${{ matrix.tool.package }}
3434
run: |
3535
if [ -n "${{ matrix.tool.apt_dependencies }}" ]; then
@@ -63,7 +63,7 @@ jobs:
6363
- uses: actions/checkout@v3
6464
- uses: actions/setup-python@v4
6565
with:
66-
python-version: '3.10'
66+
python-version: '3.11'
6767
- name: Prepare environment
6868
run: |
6969
pwd

.github/workflows/gh-pages.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Build and Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- '3.11'
7+
8+
jobs:
9+
sphinx-lint:
10+
name: Check docs (sphinx-lint)
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
with:
15+
token: ${{ secrets.GITHUB_TOKEN }}
16+
- uses: actions/setup-python@v4
17+
with:
18+
python-version: '3.11'
19+
- name: Install sphinx-lint
20+
run: python -m pip install --upgrade sphinx-lint
21+
- name: Run sphinx-lint
22+
run: 'sphinx-lint --enable default-role --ignore .git'
23+
24+
deploy:
25+
name: 'Generate docs and deploy to GitHub Pages'
26+
runs-on: ubuntu-latest
27+
needs: sphinx-lint
28+
timeout-minutes: 30
29+
steps:
30+
- uses: actions/checkout@v3
31+
- uses: actions/setup-python@v4
32+
with:
33+
python-version: '3.11'
34+
- name: Prepare environment
35+
run: |
36+
git clone https://github.com/python/cpython.git venv/cpython/
37+
python -m pip install --upgrade pip setuptools wheel
38+
python -m pip install -r requirements.txt -r venv/cpython/Doc/requirements.txt
39+
- name: Make
40+
run: make
41+
- name: Deploy to GitHub Pages
42+
uses: peaceiris/actions-gh-pages@v3
43+
with:
44+
github_token: ${{ secrets.GITHUB_TOKEN }}
45+
publish_dir: ./venv/cpython/Doc/build/html
46+
publish_branch: gh-pages
47+
allow_empty_commit: true
48+
user_name: 'github-actions[bot]'
49+
user_email: 'github-actions[bot]@users.noreply.github.com'

0 commit comments

Comments
 (0)