Skip to content
This repository has been archived by the owner on Aug 27, 2024. It is now read-only.

Workflow file for this run

name: Deploy sphinx with GitHub Pages
on:
release:
types:
- published
# 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 job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
# --- build docs ---
- name: Set up python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install sphinx
run: |
pip install wheel
pip install -r docs/requirements.txt
- name: Install pandoc
run: sudo apt-get install -y pandoc
- name: Build docs
run: |
sphinx-build -b html ./docs ./docs/_build
# -----------------
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: './docs/_build'
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2