Skip to content

Add PEP 484 type hints to transpiler analysis and utility passes (#15… #2382

Add PEP 484 type hints to transpiler analysis and utility passes (#15…

Add PEP 484 type hints to transpiler analysis and utility passes (#15… #2382

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
tags:
# Run on all tags.
- "*"
workflow_dispatch:
jobs:
build:
if: github.repository_owner == 'Qiskit'
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
# We need to fetch the whole history so 'reno' can do its job and we can inspect tags.
fetch-depth: 0
- uses: actions/setup-python@v6
name: Install Python
with:
python-version: "3.14"
- name: Install dependencies
run: tools/install_ubuntu_docs_dependencies.sh
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: Determine GitHub branch name
run: |
# Tags like 1.0.0 and 1.0.0rc1 should point to their stable branch. We do this
# to reduce the diff in the qiskit/documentation repository between generating
# the API docs from a tag release versus a workflow_dispatch.
if [[ $GITHUB_REF_NAME =~ ^([0-9]+\.[0-9]+) ]]; then
BRANCH_NAME="stable/${BASH_REMATCH[1]}"
else
BRANCH_NAME="$GITHUB_REF_NAME"
fi
echo "Using branch '${BRANCH_NAME}' for GitHub source code links"
echo "QISKIT_DOCS_GITHUB_BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
- name: Build documentation
run: tox run -e docs
- name: Store built documentation artifact
uses: actions/upload-artifact@v7
with:
name: qiskit-docs
path: |
./docs/_build/html/*
!**/.doctrees
!**/.buildinfo
if-no-files-found: error