Skip to content

[chore] changelog, sdist upload, docs #174

[chore] changelog, sdist upload, docs

[chore] changelog, sdist upload, docs #174

Workflow file for this run

name: Docs
on:
# Run build & publish on pushes targeting the default branch (after PR is merged)
push:
branches:
- main
# Run build during PRs (but not publish)
pull_request:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
docs:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Build Documentation
run: |
make -C docs html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: 'docs/_build/html'
pages:
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: [docs]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1