fix: use github app to bypass the main branch protections. (#872) #3520
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
name: docs | |
on: [push, pull_request] | |
jobs: | |
check-documentation: | |
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python 3.11 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.11 | |
- name: Setup software environment | |
run: | | |
sudo apt update | |
sudo apt install -y openmpi-bin libopenmpi-dev | |
- name: Setup Python environment | |
run: | | |
python -m pip install --upgrade pip | |
pip install -e .[docs] | |
- name: Build documentation, nitpick, and fail on warnings | |
run: cd docs && sphinx-build -nW -b html . _build/html |