Skip to content

Commit

Permalink
Test documentation build in pull requests
Browse files Browse the repository at this point in the history
  • Loading branch information
tovrstra committed Jun 13, 2024
1 parent 4896520 commit 3dfe4ce
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
1 change: 0 additions & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# - Update some actions to more recent versions

name: release

on: push

env:
Expand Down
15 changes: 12 additions & 3 deletions .github/workflows/sphinx.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,16 @@
# using the "GitHub Actions" option.

name: sphinx
on: push
on:
push:
branches:
# Run tests for change on the main branch ...
- main
tags-ignore:
# ... but not for tags (avoids duplicate work).
- '**'
pull_request:
# Run tests on pull requests

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
Expand Down Expand Up @@ -33,8 +42,8 @@ jobs:
uses: actions/configure-pages@v5
- name: Install development version
run: pip install -e .[dev]
- name: Run sphix
run: cd docs; python -m sphinx -M html . _build
- name: Run sphinx
run: cd docs; python -m sphinx -M html . _build -W --keep-going --fresh-env
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ In addition, IOData has the following dependencies:

..
Ensure changes to these dependencies are reflected
in pyproject.toml and .github/workfloews/pytest.yaml
in pyproject.toml and .github/workflows/pytest.yaml
- numpy >= 1.22: https://numpy.org/
- scipy >= 1.11: https://scipy.org/
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ classifiers = [
]
dependencies = [
# Ensure changes to these dependencies are reflected
# in .github/workfloews/pytest.yaml and docs/install.rst
# in .github/workflows/pytest.yaml and docs/install.rst
"numpy>=1.22",
"scipy>=1.11",
"attrs>=21.3.0",
Expand Down

0 comments on commit 3dfe4ce

Please sign in to comment.