Skip to content

Deploy Documentation to GitHub pages #26

Deploy Documentation to GitHub pages

Deploy Documentation to GitHub pages #26

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy Documentation to GitHub pages
on:
workflow_run:
workflows: [ "Upload Python Package To pypi" ]
branches: [ "main" ]
types:
- completed
# 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 only one concurrent deployment,
# skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow
# these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python 3.11
uses: actions/setup-python@v3
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r doc-requirements.txt
- name: Build documentation with xvfb
uses: coactions/setup-xvfb@v1
with:
run: make html
working-directory: ./docs
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Upload entire repository
path: './docs/_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2