-
-
Notifications
You must be signed in to change notification settings - Fork 147
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…roku into jsdoc-extension
1 task
1hitsong
approved these changes
Oct 27, 2023
cewert
changed the title
Auto update api docs and more
Auto update api docs and upload api docs to gh-pages
Oct 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
build-docs.yml
workflownpm run docs
and commits any changes to the unstable branchdeploy-api-docs.yml
workflowdocs/api
folder to gh-pagesdocs/api-docs-readme.md
file to be used as index page for gh-pages (new theme had a blank index)docs/api
folder when searching with vscode