Skip to content

Commit 2ef72fa

Browse files
committed
add GenAIRR demo page
1 parent 966dfdb commit 2ef72fa

6 files changed

Lines changed: 1453 additions & 0 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,16 @@ jobs:
4444
- name: Install docs dependencies
4545
run: pip install -r requirements-docs.txt
4646

47+
- name: Install GenAIRR from PyPI (mkdocstrings needs to import it)
48+
# The reference pages use `:::` mkdocstrings directives to render
49+
# signatures + docstrings from real classes (Experiment,
50+
# SimulationResult, ReferenceCartridgeBuilder, etc.). For those
51+
# to resolve, GenAIRR must be importable in the build environment.
52+
# Installing from PyPI is fast (precompiled wheels) and means the
53+
# rendered API reference matches the latest released version,
54+
# which is what published docs should reflect.
55+
run: pip install GenAIRR
56+
4757
- name: Build site with mkdocs build --strict
4858
run: make docs-build
4959
env:

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ extra_css:
8888
# <pre class="mermaid"> elements; mermaid.run() picks them up.
8989
extra_javascript:
9090
- js/mermaid-init.js
91+
- js/demo-presentation.js
9192

9293
markdown_extensions:
9394
- admonition
@@ -185,6 +186,7 @@ plugins:
185186
# placeholder is migrated to real content, add it back to nav here.
186187
nav:
187188
- Home: index.md
189+
- Demo: demo.md
188190
- Choose your path: learn.md
189191
- Getting Started:
190192
- getting-started/index.md

site_docs/assets/demo-qr.svg

Lines changed: 2 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)