Skip to content

Commit

Permalink
docs: typedoc for 3 packages
Browse files Browse the repository at this point in the history
  • Loading branch information
dckc committed Apr 12, 2024
1 parent cc9c394 commit 02a1155
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"type": "module",
"packageManager": "[email protected]",
"scripts": {
"docs": "typedoc --excludeInternal",
"format": "yarn prettier --write packages",
"lint": "yarn workspaces run lint",
"test": "yarn workspaces run test"
Expand Down
8 changes: 8 additions & 0 deletions packages/rpc/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": [
"../../typedoc.base.json"
],
"entryPoints": [
"index.ts",
]
}
8 changes: 8 additions & 0 deletions packages/web-components/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": [
"../../typedoc.base.json"
],
"entryPoints": [
"index.js",
]
}
4 changes: 4 additions & 0 deletions typedoc.base.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true
}
10 changes: 10 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"entryPoints": [
"packages/*",
],
"name": "API documentation of Agoric ui-kit",
"entryPointStrategy": "packages",
"out": "api-docs",
"includeVersion": true,
"logLevel": "Verbose"
}

0 comments on commit 02a1155

Please sign in to comment.