Skip to content

Commit b87ac0b

Browse files
authored
Split up API reference (#277)
Addresses #275. Basically just needed to get the existing gen_ref_nav.py to work again with sub-packages.
1 parent e57d595 commit b87ac0b

File tree

19 files changed

+123
-134
lines changed

19 files changed

+123
-134
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: 'Pull bloqade submodules'
2+
description: 'Composite action to pull in the git repositories of bloqade-* submodules at the latest version tags compatible with bloqade. They are put in a directory called submodules'
3+
runs:
4+
using: "composite"
5+
steps:
6+
- name: extract bloqade-circuit version
7+
id: bloqade_circuit_extract_version
8+
shell: bash
9+
run: |
10+
VERSION=$(uv pip show bloqade-circuit | awk '/^Version: / {print "v"$2}')
11+
echo "version=$VERSION" >> $GITHUB_OUTPUT
12+
13+
- name: clone the latest bloqade-circuit release
14+
id: clone_bloqade_circuit
15+
uses: actions/checkout@v5
16+
with:
17+
repository: QuEraComputing/bloqade-circuit
18+
path: 'submodules/bloqade-circuit'
19+
ref: ${{ steps.bloqade_circuit_extract_version.outputs.version }}
20+
21+
- name: Extract bloqade-analog version
22+
id: bloqade_analog_extract_version
23+
shell: bash
24+
run: |
25+
VERSION=$(uv pip show bloqade-analog | awk '/^Version: / {print "v"$2}')
26+
echo "version=$VERSION" >> $GITHUB_OUTPUT
27+
28+
- name: clone the latest bloqade-analog release
29+
id: clone_bloqade_analog
30+
uses: actions/checkout@v5
31+
with:
32+
repository: QuEraComputing/bloqade-analog
33+
path: 'submodules/bloqade-analog'
34+
ref: ${{ steps.bloqade_analog_extract_version.outputs.version }}

.github/workflows/devdoc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ jobs:
2525
cache-dependency-glob: "uv.lock"
2626
- name: Install Documentation dependencies
2727
run: uv sync --group doc
28+
29+
- name: Pull bloqade submodules
30+
uses: ./.github/pull_bloqade_submodules
31+
2832
- name: Set up build cache
2933
uses: actions/cache@v4
3034
id: cache

.github/workflows/doc-nightly.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ jobs:
2424
- name: Install Documentation dependencies
2525
run: uv sync --group doc
2626

27+
- name: Pull bloqade submodules
28+
uses: ./.github/pull_bloqade_submodules
29+
2730
- name: Set up build cache
2831
uses: actions/cache@v4
2932
id: cache

.github/workflows/doc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,21 @@ jobs:
1616
runs-on: ubuntu-latest
1717
steps:
1818
- uses: actions/checkout@v5
19+
1920
- name: Install uv
2021
uses: astral-sh/setup-uv@v6
2122
with:
2223
# Install a specific version of uv.
2324
version: "0.5.1"
2425
enable-cache: true
2526
cache-dependency-glob: "uv.lock"
27+
2628
- name: Install Documentation dependencies
2729
run: uv sync --group doc
30+
31+
- name: Pull bloqade submodules
32+
uses: ./.github/pull_bloqade_submodules
33+
2834
- name: Set up build cache
2935
uses: actions/cache@v4
3036
id: cache

docs/reference/analog.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/reference/analysis.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/reference/cirq_utils.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/reference/device.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/reference/index.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/reference/pyqrack.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)