Skip to content

Add API docs for disco#580

Merged
s314cy merged 6 commits intodevelopfrom
NAN-docs-s314cy
Aug 2, 2023
Merged

Add API docs for disco#580
s314cy merged 6 commits intodevelopfrom
NAN-docs-s314cy

Conversation

@s314cy
Copy link
Copy Markdown
Contributor

@s314cy s314cy commented Jun 29, 2023

Description

Provides discojs (discojs-{core,node,web}) with centralized docs, under the form of HTML pages accessible at some path from epfml.github.io/disco. To do so, we use the typedoc pkg which generates HTML API docs based on code documentation.

Additions & Changes

  • add and config the typedoc pkg
  • add code documentation
  • ensure the docs tree provides the right tree structure (done either by adding typedoc configs or by slightly modifying the discojs exports tree)
  • expose the HTML docs on a path from epfml.github.io/disco

@s314cy s314cy added documentation Improvements or additions to documentation discojs Related to Disco.js labels Jun 29, 2023
@s314cy s314cy self-assigned this Jun 29, 2023
@s314cy s314cy changed the title discojs: add typedoc w/ oxide theme add API docs for disco Jun 29, 2023
@s314cy s314cy changed the title add API docs for disco Add API docs for disco Jun 29, 2023
@s314cy s314cy force-pushed the NAN-docs-s314cy branch 7 times, most recently from d2f10d5 to 1146304 Compare July 6, 2023 10:19
@s314cy s314cy force-pushed the NAN-docs-s314cy branch from f9765b3 to f47f586 Compare July 31, 2023 12:17
@s314cy
Copy link
Copy Markdown
Contributor Author

s314cy commented Aug 2, 2023

While the HTML docs can be built using npm run docs within any Disco subproject (core, web, node), exposure to the web is not a priority and thus is left for a future PR.

@s314cy s314cy marked this pull request as ready for review August 2, 2023 12:37
@s314cy s314cy merged commit a65b346 into develop Aug 2, 2023
@s314cy s314cy deleted the NAN-docs-s314cy branch August 2, 2023 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

discojs Related to Disco.js documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants