Skip to content

Merge pull request #55 from zivy/addLicense #7

Merge pull request #55 from zivy/addLicense

Merge pull request #55 from zivy/addLicense #7

Workflow file for this run

name: Deploy Sphinx docs static content to GitHub Pages
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 one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
docs-pages:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: 3.11
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r docs/requirements.txt
python -m pip install -e .
- name: Build Sphinx Documentation
run: |
make -C docs html
rm docs/build/html/.buildinfo
- name: Upload documentation
uses: actions/upload-artifact@v4
with:
name: sphinx-docs
path: docs/build/html
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
if: github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
# Upload build sphinx docs
path: 'docs/build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4