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

Auto update api docs and upload api docs to gh-pages #1418

Merged
merged 26 commits into from
Oct 27, 2023

Conversation

cewert
Copy link
Member

@cewert cewert commented Oct 16, 2023

I had to change the theme (again) for the auto-commit action to work right. The theme we were using was generating a uniqueid every time the docs were built and then updating all the html files even if there were no changes.

I also added a workflow to deploy the api docs to gh-pages but I was unable to test that on my fork 🤞

Changes

  • Recommend brightscript jsdoc vscode extension - this allows devs to auto create a function definition using a vscode shortcut (ctrl + alt + /)
  • Switch to ink-docstrap jsdoc template
  • Create build-docs.yml workflow
    • Only run for unstable branch pushes
    • Runs npm run docs and commits any changes to the unstable branch
  • Create deploy-api-docs.yml workflow
    • Only run for unstable branch pushes
    • Deploys everything in the docs/api folder to gh-pages
  • Create docs/api-docs-readme.md file to be used as index page for gh-pages (new theme had a blank index)
  • Exclude the docs/api folder when searching with vscode

@cewert cewert requested a review from a team as a code owner October 16, 2023 17:48
@cewert cewert changed the title Auto update api docs and more Auto update api docs and upload api docs to gh-pages Oct 27, 2023
@cewert cewert merged commit 00a6858 into jellyfin:unstable Oct 27, 2023
9 checks passed
@cewert cewert deleted the jsdoc-extension branch October 27, 2023 02:19
@cewert cewert added the dev-improvement This improves the dev experience in some way. label Nov 5, 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.

2 participants