Skip to content

Commit 0522765

Browse files
committed
Add typedoc
Signed-off-by: Andrew Stein <[email protected]>
1 parent 0a84160 commit 0522765

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,6 @@ venv/
6161
rust/perspective-python/perspective_python-*.data
6262
.pytest-cache/
6363
docs/static/python
64-
64+
docs/static/node
65+
docs/static/browser
66+
docs/static/viewer

rust/perspective-js/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"scripts": {
3838
"build": "node ./build.js",
3939
"clean": "rimraf dist && rimraf build && rimraf src/ts/ts-rs",
40-
"docs": "cargo doc"
40+
"docs": "npx typedoc --tsconfig tsconfig.browser.json --out ../../docs/static/browser && npx typedoc --tsconfig tsconfig.node.json --out ../../docs/static/node"
4141
},
4242
"publishConfig": {
4343
"access": "public"
@@ -50,14 +50,15 @@
5050
"devDependencies": {
5151
"@finos/perspective-cpp": "workspace:^",
5252
"@finos/perspective-esbuild-plugin": "workspace:^",
53-
"@finos/perspective-test": "workspace:^",
5453
"@finos/perspective-metadata": "workspace:^",
54+
"@finos/perspective-test": "workspace:^",
5555
"@types/stoppable": "^1.1.0",
5656
"@types/ws": "^8.18.1",
5757
"apache-arrow": "18.1.0",
5858
"cpy": "^9.0.1",
5959
"lodash": "^4.17.21",
6060
"moment": "^2.30.1",
61+
"typedoc": "^0.28.7",
6162
"underscore": "^1.13.6",
6263
"zx": "8.1.9"
6364
}

rust/perspective-viewer/package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
"scripts": {
3131
"build": "node ./build.js",
3232
"clean": "rimraf dist && rimraf build",
33-
"test:run:rust": "rustup run nightly wasm-pack test --chrome --headless"
33+
"test:run:rust": "rustup run nightly wasm-pack test --chrome --headless",
34+
"docs": "npx typedoc --tsconfig tsconfig.json --out ../../docs/static/viewer"
3435
},
3536
"publishConfig": {
3637
"access": "public"
@@ -44,9 +45,10 @@
4445
"@finos/perspective-test": "workspace:^",
4546
"@finos/perspective-metadata": "workspace:^",
4647
"@prospective.co/procss": "0.1.16",
48+
"@types/react": "^17.0.2",
4749
"cpy": "^9.0.1",
4850
"prettier": "^2.8.8",
49-
"@types/react": "^17.0.2",
51+
"typedoc": "^0.28.7",
5052
"zx": "8.1.9"
5153
}
5254
}

0 commit comments

Comments
 (0)