Check docs #677
This file contains hidden or 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
name: Check docs | |
on: | |
push: | |
pull_request: | |
schedule: | |
# Run at the end of every day | |
- cron: "0 0 * * *" | |
jobs: | |
build: | |
# Scheduled runs only on the origin org | |
if: (github.event_name == 'schedule' && github.repository_owner == 'sgkit-dev') || (github.event_name != 'schedule') | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ["3.11"] | |
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: | | |
sudo apt update -y | |
sudo apt install graphviz # Needed for documentation | |
python -m pip install --upgrade pip | |
pip install -r requirements.txt -r requirements-dev.txt -r requirements-doc.txt | |
pip install -U dask distributed # need latest versions to successully build docs | |
- name: Run pre-commit | |
uses: pre-commit/[email protected] | |
- name: Check for Sphinx doc warnings | |
run: | | |
cd docs | |
make html SPHINXOPTS="-W --keep-going -n" | |
- uses: actions/upload-artifact@v4 | |
if: failure() | |
with: | |
name: gwas_tutorial | |
path: /home/runner/work/sgkit/sgkit/docs/_build/html/reports/examples/gwas_tutorial.err.log | |
- uses: actions/upload-artifact@v4 | |
if: failure() | |
with: | |
name: relatedness_tutorial | |
path: /home/runner/work/sgkit/sgkit/docs/_build/html/reports/examples/relatedness_tutorial.err.log |