Skip to content

Commit b48bc8d

Browse files
committed
Simplify API documentation with TypeDoc
- Replace complex Sphinx/Python setup with standard TypeDoc - Move TypeDoc config from tsconfig.json to standalone typedoc.config.mjs - Update doc build scripts to use TypeDoc directly - Add GitHub Action workflow for GitHub Pages deployment
1 parent 73657e1 commit b48bc8d

File tree

12 files changed

+557
-1022
lines changed

12 files changed

+557
-1022
lines changed

.github/workflows/docs.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Build and Deploy API Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "src/**"
9+
- "typedoc.config.mjs"
10+
- ".github/workflows/docs.yml"
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: false
21+
22+
jobs:
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
29+
- name: Setup Node
30+
uses: actions/setup-node@v4
31+
with:
32+
node-version: "22"
33+
cache: "npm"
34+
35+
- name: Install dependencies
36+
run: npm ci
37+
38+
- name: Build documentation
39+
run: npm run docs:build
40+
41+
- name: Setup Pages
42+
uses: actions/configure-pages@v4
43+
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: "./docs"
48+
49+
deploy:
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
runs-on: ubuntu-latest
54+
needs: build
55+
steps:
56+
- name: Deploy to GitHub Pages
57+
id: deployment
58+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,12 @@ umd
66
whitesource/
77
LICENSE_DEPENDENCIES
88
LICENSE_DEPENDENCIES_ALL
9-
docs/api/build/
10-
docs/api/source/api/
11-
docs/api/docs-assets/
12-
docs/dist/
9+
docs/
1310
.env*.local
1411
.codesandbox/sandbox/.parcel-cache/
1512
test-results/
1613
.vercel
1714
.virtualenv
1815
.parcel-cache/
19-
.vscode/settings.json
16+
.vscode/
2017
coverage

docs/README.md

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

docs/api/Makefile

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

docs/api/conf.py

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

docs/api/redirects.txt

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

0 commit comments

Comments
 (0)