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

Add yarn docs command to generate API documentation #280

Merged
merged 5 commits into from
Oct 11, 2023
Merged

Add yarn docs command to generate API documentation #280

merged 5 commits into from
Oct 11, 2023

Conversation

rolandkakonyi
Copy link
Contributor

@rolandkakonyi rolandkakonyi commented Oct 9, 2023 •
edited
Loading

Description

This PR adds a new yarn docs command to generate API docs.
This will be used for CI automation in follow up PRs.

Changes

Introduced typedoc dependency and added configuration in typedoc.json.

Here is the generated output:
apidocs.zip

Checklist

  • 🗒 CHANGELOG entry - not applicable

@rolandkakonyi rolandkakonyi self-assigned this Oct 9, 2023
@rolandkakonyi rolandkakonyi marked this pull request as ready for review October 9, 2023 12:48
matamegger
matamegger approved these changes Oct 11, 2023
View reviewed changes
Copy link
Contributor

@matamegger matamegger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice!

@rolandkakonyi rolandkakonyi merged commit 386630c into development Oct 11, 2023
5 checks passed
@rolandkakonyi rolandkakonyi deleted the add-api-docs-generation-command branch October 11, 2023 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matamegger matamegger matamegger approved these changes

Assignees

@rolandkakonyi rolandkakonyi

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rolandkakonyi @matamegger