fix(docs): the API reference documented nothing - #65
Merged
Conversation
Dokka's Android adapter names source sets after the variants (debug, release, staging and the test ones); there is no "main". The guard that suppressed every source set but "main" therefore suppressed all of them, and every module reached the generator with no sources: the published reference was an empty "All modules" page. Keep the release source set, suppress the rest, and label it "android" in the rendered reference.
damwilin
force-pushed
the
fix/dokka-empty-reference
branch
from
September 9, 2026 16:02
33b6be8 to
033d810
Compare
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
The docs workflow (
.github/workflows/docs.yml) publishes the Dokka API reference under/api, but the reference it produced was empty: an "All modules" page with nothing behind it. Every module's Dokka block suppressed all source sets except one calledmain, and Dokka's Android adapter never creates one - it names source sets after the variants (debug,release,stagingand the test ones). So every source set was suppressed and each module reached the generator withsourceSets=[]("Nothing to document").The fix keeps the
releasesource set, suppresses the rest (they all document the samesrc/main/java, and one set keeps source-link merging unambiguous) and labels itandroidin the rendered pages. Same task, same output directory, so the workflow and the site layout are unchanged.Type of Change
Affected Areas
Testing
./gradlew testDebugUnitTest --no-daemon --stacktrace-:playerre-run green after the change (build-script only)./gradlew :app:assembleDebug --no-daemon./gradlew dokkaGeneratePublicationHtml: 1168 HTML pages (api 737, player 365, recording 64), root index lists the three modules with theirModule.mdblurbs,BunnyStreamApi/BunnyStreamPlayer/BunnyLiveStreamPlayer/StreamCameraUploadViewpages present, noorg.openapitoolspages, zero classpath warnings. Rendered locally with mkdocs + the Dokka output the way the workflow assembles the site.SDK User Impact
None at runtime. The published API reference goes from empty to complete once the docs workflow runs (it triggers on version tags or manually); GitHub Pages must be enabled on the repository with "GitHub Actions" as the source.
AI Assistance
Checklist