Skip to content
Build Sphinx docs

Add unit tests, clean up documentation, and add error handling in qubit module. #198

Sign in to view logs

Add unit tests, clean up documentation, and add error handling in qubit module.

Add unit tests, clean up documentation, and add error handling in qubit module. #198

Workflow file for this run

.github/workflows/docs.yml at 4a3fb4f
name: Build Sphinx docs
on:
workflow_dispatch:
push:
tags:
- "[0-9]+.[0-9]+.[0-9]+*"
branches:
- main
- 'stable/**'
pull_request:
branches:
- main
- 'stable/**'
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox
sudo apt-get update
sudo apt-get install -y pandoc
- name: Build docs
shell: bash
run: |
tox -edocs
- name: Upload docs artifact
if: always()
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
deploy:
name: Deploy docs
if: ${{ github.ref == 'refs/heads/stable/0.6' }}
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4