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

Invoke typedoc to produce browsable JS API documentation #4757

Merged
merged 23 commits into from
Nov 17, 2023
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
abe8aad
Clean up javadoc, adding link references where appropriate
niloc132 Nov 7, 2023
bc8e69f
Correct jsinterop annotations
niloc132 Nov 7, 2023
bf31ca7
First draft of generating js api docs from ts
niloc132 Apr 13, 2023
2fdaa79
Correct cli flags for generating docs
niloc132 Aug 7, 2023
0b22425
quick and dirty ts/js doc deployment
niloc132 Aug 7, 2023
365ae3b
Add support for more ts types
niloc132 Aug 10, 2023
6a77af2
Switch to javadoc-based generation
niloc132 Oct 21, 2023
7167461
Tidy up javadoc
niloc132 Oct 25, 2023
d730039
Correctly pin versions for typedoc
niloc132 Oct 25, 2023
219a667
Also package tarball from types
niloc132 Oct 26, 2023
1f17332
Tidy up javadoc a bit, prep for release
niloc132 Nov 1, 2023
04c6841
Update args to improve output
niloc132 Nov 1, 2023
0bccc97
Clean up typedoc deploy content, apply custom dark theme
niloc132 Nov 1, 2023
26071d9
Update to new release
niloc132 Nov 1, 2023
5e4c15e
Remove old processor that we don't need any more
niloc132 Nov 1, 2023
c75f2d2
Add missing task dependency
niloc132 Nov 1, 2023
f0b47fd
cleanup for review
niloc132 Nov 7, 2023
091a8cf
Merge branch 'main' into typedoc
niloc132 Nov 16, 2023
665db2d
Move typedoc to its own separate job
niloc132 Nov 17, 2023
0950b0f
Temp commit, switch branch to build and disable other doc jobs+rsync
niloc132 Nov 17, 2023
4ffdacd
Revert "Temp commit, switch branch to build and disable other doc job…
niloc132 Nov 17, 2023
76607ff
Set job-id to a unique value for typedoc
niloc132 Nov 17, 2023
7b3c709
Correct another copy/paste
niloc132 Nov 17, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Correct another copy/paste
niloc132 committed Nov 17, 2023
commit 7b3c709185ec5855f4b06ca57369fede9dca9839
2 changes: 1 addition & 1 deletion .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
@@ -68,7 +68,7 @@ jobs:
typedoc:
runs-on: ubuntu-22.04
concurrency:
group: javadoc-${{ github.workflow }}-${{ github.ref }}
group: typedoc-${{ github.workflow }}-${{ github.ref }}
# We don't want to cancel in-progress jobs against main because that might leave the upload in a bad state.
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
steps: