Skip to content

Commit 79a85dc

Browse files
committed
Fix documentation links
1 parent b777b19 commit 79a85dc

3 files changed

Lines changed: 14 additions & 11 deletions

File tree

.github/workflows/docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ jobs:
106106
id: compute-base
107107
run: |
108108
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
109-
echo "base=/pr-preview/pr-${{ github.event.pull_request.number }}" >> "$GITHUB_OUTPUT"
109+
echo "base=/ppvm/pr-preview/pr-${{ github.event.pull_request.number }}" >> "$GITHUB_OUTPUT"
110110
else
111-
echo "base=/" >> "$GITHUB_OUTPUT"
111+
echo "base=/ppvm/" >> "$GITHUB_OUTPUT"
112112
fi
113113
114114
- name: Compute git ref for source links
@@ -132,7 +132,7 @@ jobs:
132132
# hatches a developer would use locally.
133133
working-directory: docs
134134
env:
135-
PPVM_SITE: https://congenial-bassoon-l436wp3.pages.github.io
135+
PPVM_SITE: https://queracomputing.github.io
136136
PPVM_BASE: ${{ steps.compute-base.outputs.base }}
137137
PPVM_GIT_REF: ${{ steps.compute-ref.outputs.ref }}
138138
RUSTFLAGS: "-C target-feature=+aes,+sse2"

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A fast quantum circuit simulator written in Rust, with Python bindings.
44

5-
[![Docs](https://img.shields.io/badge/docs-6437FF)](https://congenial-bassoon-l436wp3.pages.github.io/)
5+
[![Docs](https://img.shields.io/badge/docs-6437FF)](https://queracomputing.github.io/ppvm/)
66
[![CI - rust](https://github.com/QuEraComputing/ppvm/actions/workflows/rust-ci.yml/badge.svg)](https://github.com/QuEraComputing/ppvm/actions/workflows/rust-ci.yml)
77
[![CI - python](https://github.com/QuEraComputing/ppvm/actions/workflows/python-ci.yml/badge.svg)](https://github.com/QuEraComputing/ppvm/actions/workflows/python-ci.yml)
88
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
@@ -52,7 +52,7 @@ r0, r1 = tab.measure(0), tab.measure(1)
5252
print(f"Qubit 0: {r0}, Qubit 1: {r1}") # always correlated
5353
```
5454

55-
See the [documentation](https://congenial-bassoon-l436wp3.pages.github.io/) for the Rust API, Stim integration, and symbolic propagation.
55+
See the [documentation](https://queracomputing.github.io/ppvm/) for the Rust API, Stim integration, and symbolic propagation.
5656

5757
## License & contributing
5858

docs/astro.config.mjs

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@ import { defineConfig } from "astro/config";
22

33
// `site` + `base` are read from env in CI so the same astro config powers
44
// three deploy targets:
5-
// · local dev: PPVM_SITE=http://localhost:4321 PPVM_BASE=/
6-
// · main → gh-pages: PPVM_SITE=https://congenial-bassoon-l436wp3.pages.github.io PPVM_BASE=/
7-
// · PR preview deploy: PPVM_SITE=https://congenial-bassoon-l436wp3.pages.github.io PPVM_BASE=/pr-preview/pr-<N>
8-
const site =
9-
process.env.PPVM_SITE ??
10-
"https://congenial-bassoon-l436wp3.pages.github.io";
5+
// · local dev: PPVM_SITE=http://localhost:4321 PPVM_BASE=/
6+
// · main → gh-pages: PPVM_SITE=https://queracomputing.github.io PPVM_BASE=/ppvm/
7+
// · PR preview deploy: PPVM_SITE=https://queracomputing.github.io PPVM_BASE=/ppvm/pr-preview/pr-<N>
8+
//
9+
// The site is a GitHub Pages *project* page served from the `/ppvm/`
10+
// subpath, so the deployed base must be `/ppvm/`. The default base stays
11+
// `/` for local dev (`npm run dev` → http://127.0.0.1:4321/); CI sets
12+
// PPVM_BASE explicitly for the two deploy targets.
13+
const site = process.env.PPVM_SITE ?? "https://queracomputing.github.io";
1114
const base = process.env.PPVM_BASE ?? "/";
1215

1316
export default defineConfig({

0 commit comments

Comments
 (0)