Skip to content

Merge pull request #9 from ISISNeutronMuon/8-plugin-api #33

Merge pull request #9 from ISISNeutronMuon/8-plugin-api

Merge pull request #9 from ISISNeutronMuon/8-plugin-api #33

Workflow file for this run

name: Build & Deploy Sphinx Docs
on:
push:
branches: [main]
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: 📥 Checkout code
uses: actions/checkout@v3
- name: 🐍 Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: 📦 Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx furo sphinx-autodoc-typehints
# - name: 🛠️ Build documentation # we are just using the uploaded ones
# run: |
# cd docs
# make html
- name: 📂 Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html/
deploy:
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
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@v4 # or specific "vX.X.X" version tag for this action