Skip to content

Starting to use typedoc #41

@bryevdv

Description

@bryevdv

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.

image

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions