Skip to content

Merge pull request #29 from jgrethe/main #14

Merge pull request #29 from jgrethe/main

Merge pull request #29 from jgrethe/main #14

Workflow file for this run

name: Sphinx build
on:
push:
branches:
- main # Run if it is a push to main
jobs:
check:
uses: ./.github/workflows/CI.yml
build:
needs: check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Build HTML
run: |
python -m pip install --upgrade pip
pip install -e .
pip install sphinx sphinx_rtd_theme
sphinx-build docs docs/_build/html/
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload built website
path: 'docs/_build/html'
deploy:
# Add a dependency to the build job
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@v1