Skip to content

Merge pull request #47 from qec-codes/sphinx-documentation #2

Merge pull request #47 from qec-codes/sphinx-documentation

Merge pull request #47 from qec-codes/sphinx-documentation #2

Workflow file for this run

name: Deploy Sphinx documentation to GitHub Pages
on:
push:
branches:
- main
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx myst-parser sphinx-rtd-theme
- name: Build HTML
run: sphinx-build -b html docs/source docs/_build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html