Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Starting to use typedoc #41

Closed
bryevdv opened this issue Dec 1, 2020 · 3 comments
Closed

Starting to use typedoc #41

bryevdv opened this issue Dec 1, 2020 · 3 comments

Comments

@bryevdv
Copy link
Contributor

bryevdv commented Dec 1, 2020

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

@bryevdv
Copy link
Contributor Author

bryevdv commented Dec 1, 2020

Also to note: AFAIK we will need to invoke typedoc separately for each module to get good results, but I be missing some configuration option

@trxcllnt
Copy link
Collaborator

trxcllnt commented Dec 8, 2020

We have typedoc set up in Arrow and IxJS, and should be able to follow those examples. We can add an npm "doc" script to build the docs for each module, plus a typedoc.js config file to customize things.

@trxcllnt
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants