Skip to content

Deploy Docs to GitHub Pages #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 15, 2022
Merged

Deploy Docs to GitHub Pages #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7406412
gh-pages
egeakman Dec 15, 2022
91f4e68
gh-pages
egeakman Dec 15, 2022
3a1997c
gh-pages
egeakman Dec 15, 2022
2fc8461
final
egeakman Dec 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: '3.11'
- name: Install ${{ matrix.tool.package }}
run: |
if [ -n "${{ matrix.tool.apt_dependencies }}" ]; then
Expand Down Expand Up @@ -63,7 +63,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: '3.11'
- name: Prepare environment
run: |
pwd
Expand Down
49 changes: 49 additions & 0 deletions .github/workflows/gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Build and Deploy to GitHub Pages

on:
push:
branches:
- '3.11'

jobs:
sphinx-lint:
name: Check docs (sphinx-lint)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install sphinx-lint
run: python -m pip install --upgrade sphinx-lint
- name: Run sphinx-lint
run: 'sphinx-lint --enable default-role --ignore .git'

deploy:
name: 'Generate docs and deploy to GitHub Pages'
runs-on: ubuntu-latest
needs: sphinx-lint
timeout-minutes: 30
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Prepare environment
run: |
git clone https://github.com/python/cpython.git venv/cpython/
python -m pip install --upgrade pip setuptools wheel
python -m pip install -r requirements.txt -r venv/cpython/Doc/requirements.txt
- name: Make
run: make
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./venv/cpython/Doc/build/html
publish_branch: gh-pages
allow_empty_commit: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'