Skip to content

Merge remote-tracking branch 'origin/main' #2

Merge remote-tracking branch 'origin/main'

Merge remote-tracking branch 'origin/main' #2

Workflow file for this run

name: Deploy Sphinx Docs to 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:
permissions:
contents: read
pages: write
id-token: write
jobs:
# Build job
build:
runs-on: ubuntu-latest
container:
image: python:3.11
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-book-theme sphinx-autodoc-typehints myst-parser sphinx_design
- name: Build Sphinx Documentation
run: |
cd docs
make html
- name: Upload Sphinx Build Artifact
if: ${{ env.SKIP_ARTIFACT_UPLOAD != 'true' }}
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
# 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@v4