Skip to content

Commit ce83fa5

Browse files
committed
Add IR Viewer tool to docs
1 parent cbb6597 commit ce83fa5

3 files changed

Lines changed: 52 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
jobs:
17+
deploy:
18+
runs-on: ubuntu-latest
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
steps:
23+
- uses: actions/checkout@v4
24+
25+
- name: Setup Python
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: '3.12'
29+
30+
- name: Install dependencies
31+
run: |
32+
pip install mkdocs mkdocs-material
33+
34+
- name: Build docs
35+
run: mkdocs build
36+
37+
- name: Setup Pages
38+
uses: actions/configure-pages@v4
39+
40+
- name: Upload artifact
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: ./site
44+
45+
- id: deployment
46+
uses: actions/deploy-pages@v4

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,7 @@ TeraXLang is a Triton-based language extension that provides additional features
1111

1212
- [Core API](api/core.md) - Low-level TeraXLang primitives
1313
- [JIT API](api/jit.md) - JIT compilation utilities
14+
15+
## Tools
16+
17+
- [IR Viewer](tools/ir-viewer.html) - Interactive binding viewer for TTIR/TTGIR/PTX and Python source

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ nav:
1414
- API:
1515
- Core: api/core.md
1616
- JIT: api/jit.md
17+
- Tools:
18+
- IR Viewer: tools/ir-viewer.html

0 commit comments

Comments
 (0)