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

Create api docs using jsdoc #1405

Merged
merged 7 commits into from
Oct 15, 2023
Merged

Create api docs using jsdoc #1405

merged 7 commits into from
Oct 15, 2023

Conversation

cewert
Copy link
Member

@cewert cewert commented Oct 6, 2023

This adds automatically generated docs for our code using jsdoc style function comments. Function names, descriptions, params, param types, and return types are automatically grabbed with the option of manually adding more info.

I wasn't able to get search working but I believe that can be fixed after this gets merged and hosted online. At least that was my plan, was to host these docs using github pages.

I put the auto generated docs in the docs/api folder instead of the default docs folder that way we have somewhere to put our other docs like the DEVGUIDE. api might not be the best folder name but I couldn't think of a better name.

Changes

  • Install jsdoc and brighterscript-jsdocs-plugin as dev dependencies
  • Use theme with dark mode
  • Create npm script to generate docs - npm run docs
  • Move DEVGUIDE.md to docs/
  • Generate docs @ docs/api

@cewert cewert requested a review from a team as a code owner October 6, 2023 03:59
@jellyfin-bot jellyfin-bot added the merge-conflict This PR has a merge conflict label Oct 7, 2023
@jellyfin-bot
Copy link
Contributor

This pull request has merge conflicts. Please resolve the conflicts so the PR can be reviewed. Thanks!

@jellyfin-bot jellyfin-bot removed the merge-conflict This PR has a merge conflict label Oct 7, 2023
@1hitsong
Copy link
Member

This is killer. Looks like search isn't working locally due to CORS policy, so you're right, it'll likely fix itself when hosted.

@cewert cewert merged commit 36f45cd into jellyfin:unstable Oct 15, 2023
9 checks passed
@cewert cewert deleted the setup-jsdoc branch October 15, 2023 23:11
@cewert cewert added the dev-improvement This improves the dev experience in some way. label Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-improvement This improves the dev experience in some way.
Projects
Development

Successfully merging this pull request may close these issues.

3 participants