Skip to content

[pre-commit.ci] pre-commit autoupdate #144

[pre-commit.ci] pre-commit autoupdate

[pre-commit.ci] pre-commit autoupdate #144

Workflow file for this run

name: doc
concurrency:
group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
cancel-in-progress: true
on: # yamllint disable-line rule:truthy
pull_request:
push:
branches: [main]
workflow_dispatch:
jobs:
build:
timeout-minutes: 30
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
path: ./main
- name: Setup Python 3.9
uses: actions/setup-python@v5
with:
python-version: 3.9
architecture: 'x64'
- name: Install linux dependencies
run: |
sudo apt update
sudo apt install optipng
- name: Setup headless display
uses: pyvista/setup-headless-display-action@main
with:
qt: true
- name: Install package
run: |
python -m pip install --progress-bar off --upgrade pip setuptools
python -m pip install --progress-bar off main/.[doc]
- name: Display system information
run: mne_icalabel-sys_info --developer
- name: Build doc
run: sphinx-build ./main/doc ./doc-build/dev -W --keep-going
- name: Prune sphinx environment
run: sudo rm -R ./doc-build/dev/.doctrees
- name: Upload documentation
uses: actions/upload-artifact@v4
with:
name: doc-dev
path: ./doc-build/dev
deploy:
if: github.event_name == 'push'
needs: build
timeout-minutes: 10
runs-on: ubuntu-latest
permissions:
contents: write
defaults:
run:
shell: bash
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Download documentation
uses: actions/download-artifact@v4
with:
name: doc-dev
path: ./doc-dev
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: ./doc-dev
target-folder: ./dev
git-config-name: 'github-actions[bot]'
git-config-email: 'github-actions[bot]@users.noreply.github.com'
single-commit: true
force: true