Skip to content

CI: Use event issue number #108

CI: Use event issue number

CI: Use event issue number #108

Workflow file for this run

name: Build documentation
on: [push, pull_request]
jobs:
build_docs:
name: Build documentation
runs-on: ubuntu-latest
strategy:
fail-fast: true
steps:
- uses: actions/checkout@v3
- uses: pdm-project/setup-pdm@v3
with:
python-version: 3.9
cache: true
- name: Install dependencies
run: pdm install -dG docs
- name: Generate documentation
run: pdm run sphinx-build -b html docs/source/ docs/build/html
- name: Archive artifact
shell: sh
if: runner.os == 'Linux'
run: |
tar \
--dereference --hard-dereference \
--exclude=.git \
--exclude=.github \
-cvf "$RUNNER_TEMP/artifact.tar" \
--directory=docs/build/html .
- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: github-pages
path: ${{ runner.temp }}/artifact.tar
if-no-files-found: error
# Deploy job
# deploy:
# # Add a dependency to the build job
# needs: build_docs
# permissions:
# pages: write # to deploy to Pages
# id-token: write # to verify the deployment originates from an appropriate source
# # Deploy to the github-pages environment
# environment:
# name: github-pages
# url: ${{ steps.deployment.outputs.page_url }}
# # Specify runner + deployment step
# runs-on: ubuntu-latest
# steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action