-
Notifications
You must be signed in to change notification settings - Fork 23
Closed
Description
I played around with typedoc for generating docs for rapids-js modules. Initial attempts were fairly unsatisfactory, but I stumbled across the new beta, which adds a "library mode" that is more suitable for projects like ours.
Some steps:
install typedoc beta (0.20)
npm install typedoc@beta
install babel template manually
Maybe a quirk on my system, I had to install this by hand
npm install @types/babel__template
run typedoc on a single module
npx typedoc --out testdocs modules/cudf/src/index.ts --excludePrivate --tsconfig modules/cudf/tsconfig.json
note that in previous versions --excludePrivate
seemed to prevent attributes like _data
from showing up, but they are still showing up for me when the beta is used.
Metadata
Metadata
Assignees
Labels
No labels