[pre-commit.ci] pre-commit autoupdate (#65) #266
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: 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: 10 | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
shell: bash | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup Python 3.9 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.9 | |
- name: Install linux dependencies | |
run: | | |
sudo apt update | |
sudo apt install -y optipng | |
- name: Install uv and package | |
run: | | |
python -m pip install --quiet uv | |
uv pip install --quiet --system .[doc] | |
- name: Display system information | |
run: template sys-info --developer | |
- name: Build doc | |
run: make -C doc html | |
- name: Prune sphinx environment | |
run: rm -R ./doc/_build/html/.doctrees | |
- name: Upload documentation | |
uses: actions/upload-artifact@v4 | |
with: | |
name: doc-dev | |
path: ./doc/_build/html | |
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 |