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.

Sign up for GitHub

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

Jump to bottom

Generate TypeScript API documentation #4

Open
samuelmaddock opened this issue May 28, 2020 · 0 comments
Open

Generate TypeScript API documentation #4

samuelmaddock opened this issue May 28, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@samuelmaddock
Copy link
Contributor

samuelmaddock commented May 28, 2020 •
edited
Loading

It'd be nice to generate documentation for code exported in index.ts.

Since we're using TypeScript, this can be done easily with https://typedoc.org/

The tsconfig.json likely needs to be updated to output typescript definition files (.d.ts). 21a5ce8
@samuelmaddock samuelmaddock added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 28, 2020
@samuelmaddock samuelmaddock changed the title Generate documentation Generate TS documentation May 28, 2020
@samuelmaddock samuelmaddock changed the title Generate TS documentation Generate TypeScript API documentation May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@samuelmaddock