Merge pull request #1195 from pysat/maint/nep29_april24 #17
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow will install Python dependencies, run tests and lint with a | |
# variety of Python versions. For more information see: | |
# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
name: Documentation Check | |
on: [push, pull_request] | |
jobs: | |
build: | |
runs-on: ["ubuntu-latest"] | |
strategy: | |
fail-fast: false | |
matrix: | |
python-version: ["3.10"] | |
name: Documentation tests | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: pip install .[doc] | |
- name: Set up pysat | |
run: | | |
mkdir pysatData | |
python -c "import pysat; pysat.params['data_dirs'] = './pysatData'" | |
- name: Check documentation build | |
run: sphinx-build -E -b html docs dist/docs | |
- name: Check documentation links | |
run: sphinx-build -b linkcheck docs dist/docs | |
- name: Load .zenodo.json to check for errors | |
run: python -c "import json; json.loads(open('.zenodo.json').read())" |