Skip to content

Version 1.8.0

Version 1.8.0 #99

Workflow file for this run

name: Build and Deploy Sphinx Docs
on:
push:
branches:
- main
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Check out the repository
# Verify: bash maintainer/verify_github_actions.sh actions/checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Python
# Verify: bash maintainer/verify_github_actions.sh actions/setup-python
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[dev]"
- name: Build Sphinx documentation
run: |
sphinx-build -b html doc/source doc/_build/html -v
- name: List generated HTML files
run: |
ls -l -R doc/_build/html
- name: Deploy to GitHub Pages
# Verify: bash maintainer/verify_github_actions.sh peaceiris/actions-gh-pages
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: documentation
publish_dir: doc/_build/html
destination_dir: docs
enable_jekyll: false