Skip to content

Merge branch 'main' of github.com:qupath/qubalab-docs #7

Merge branch 'main' of github.com:qupath/qubalab-docs

Merge branch 'main' of github.com:qupath/qubalab-docs #7

Workflow file for this run

# This workflow will build and publish documentation to GitHub pages on pushes to the main branch or when manually activated
# This workflow can only be run from the 'main' branch
name: docs
on:
push:
branches:
- main
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Check out qubalab
uses: actions/checkout@v4
with:
repository: qupath/qubalab
ref: main
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
path: qubalab
- name: Set up python
id: setup-python
uses: actions/setup-python@v5
- name: Install qubalab
run: pip install ./qubalab[doc]
- name: Build documentation
run: sphinx-build -M html . _build/
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4