Repository navigation
Generate and publish KDoc via Dokka + GitHub Pages - #116
Merged
Merged
Conversation
Aggregates KDoc from core and plugin into a single Dokka HTML site, built and deployed to GitHub Pages on every push to master. Also lets core's javadoc jar be auto-derived from Dokka instead of staying empty.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
mzielu
reviewed
Oct 13, 2026
Co-authored-by: Junie <junie@jetbrains.com>
Contributor
Author
|
(I don't have perms to merge it) |
This file contains hidden or 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
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.
Summary
coreandplugin, aggregated at the root so./gradlew :dokkaGenerateproduces a single HTML site underbuild/dokkacovering both modules, with source links back to GitHub..github/workflows/docs.yml, which builds the docs and deploys them to GitHub Pages on every push tomaster(also runnable manually viaworkflow_dispatch).core's Maven Central javadoc jar is now auto-derived from Dokka instead of being empty (pluginkeepsJavadocJar.Empty(), which is standard for Gradle plugins).Post-merge setup (one-time, needs repo admin)
GitHub Pages must be enabled before the workflow can actually publish anything:
Docsworkflow (or push tomaster) if it already ran and failed on the deploy step before Pages was enabled.Once enabled, docs will be live at
https://avsystem.github.io/justworks/and stay up to date automatically on every merge tomaster.Test plan
./gradlew :dokkaGeneratesucceeds locally, producesbuild/dokka/index.htmlaggregating both modules./gradlew ktlintCheckpassesdocs.ymlworkflow succeeds on GitHub Actions (needs Pages enabled first, see above)