53 lines
1.5 KiB
YAML
53 lines
1.5 KiB
YAML
name: Build and Deploy Documentation
|
|
on:
|
|
# Runs on pushes targeting the default branch
|
|
push:
|
|
branches: ["main"]
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
|
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Set up latest Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "*"
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v3
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
python -m pip install --upgrade pip setuptools wheel
|
|
python -m pip install -e ".[d]"
|
|
python -m pip install -r "docs/requirements.txt"
|
|
|
|
- name: Build documentation
|
|
run: sphinx-build -a -b html --keep-going docs/ docs/_build
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v1
|
|
with:
|
|
# Upload entire repository
|
|
path: 'docs/_build'
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v2
|