Skip to content

Merge pull request #336 from epoch8/elephantum/issue313 #10

Merge pull request #336 from epoch8/elephantum/issue313

Merge pull request #336 from epoch8/elephantum/issue313 #10

Workflow file for this run

name: Build and publish docs
on:
push:
branches:
- "master"
paths:
- ".github/workflows/docs.yaml"
- "docs/**"
- "pyproject.toml"
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: pip
- name: Install dependencies
run: |
pip install ".[docs]"
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build docs
run: |
cd docs; make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3.0.1
with:
path: docs/build/html
# Deployment job
deploy:
environment:
name: github-pages
url: ${{steps.deployment.outputs.page_url}}
runs-on: ubuntu-latest
needs: build
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4