Skip to content

Commit

Permalink
build doc on every pr
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau committed Oct 4, 2024
1 parent c45ddcd commit 47a6640
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 4 deletions.
7 changes: 3 additions & 4 deletions .github/workflows/master-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,22 +64,21 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
python-version: "3.12"
- name: Install dependencies
shell: bash -l {0}
run: |
python -m pip install --upgrade pip
python -m pip install .[optional,doc]
- name: Build API documentation
run: |
python -m sphinx docs docs_build
run: make -C docs html

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: 'docs_build'
path: 'build'

- name: Deploy to GitHub Pages
id: deployment
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/test-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,30 @@ jobs:
shell: bash
run: ruff check src

makedocs:
name: build documentation
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Get history and tags for SCM versioning to work
run: |
git fetch --prune --unshallow
git fetch --depth=1 origin +refs/tags/*:refs/tags/*
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
shell: bash -l {0}
run: |
python -m pip install --upgrade pip
python -m pip install .[optional,doc]
- name: Build API documentation
run: make -C docs html

codespell:
name: Check for spelling errors
runs-on: ubuntu-latest
Expand Down

0 comments on commit 47a6640

Please sign in to comment.