Skip to content
This repository was archived by the owner on Nov 12, 2024. It is now read-only.

Generate documentation with typedoc #271

Closed
wants to merge 8 commits into from
Closed

Generate documentation with typedoc #271

wants to merge 8 commits into from

Conversation

dvsilviyageo
Copy link
Contributor

closes #268

Summary:

  • Added typedoc to package.json in core, plotly, echarts and vega.
  • Edited tsConfig file for packages.
  • Added comments to ts files in the package.
  • Generated docs in the folder documentation for each packages and core.

TODO:

  • Fix the modebar type error in core. It is commented out to generate docs.
  • In vega - In scatterplot.ts and change matrix.ts the min and max is commented out to generate doc

@dvsilviyageo dvsilviyageo added the documentation Improvements or additions to documentation label Feb 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dvdanielamoitzi dvdanielamoitzi Awaiting requested review from dvdanielamoitzi

Assignees

@dvdanielamoitzi dvdanielamoitzi

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add TypeDoc
2 participants
@dvsilviyageo @dvdanielamoitzi