Skip to content

fix(docs): the API reference documented nothing - #65

Merged
bogdan-at-bunny merged 2 commits into
mainfrom
fix/dokka-empty-reference
Sep 10, 2026
Merged

fix(docs): the API reference documented nothing#65
bogdan-at-bunny merged 2 commits into
mainfrom
fix/dokka-empty-reference

Conversation

@damwilin

@damwilin damwilin commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

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 called main, and Dokka's Android adapter never creates one - it names source sets after the variants (debug, release, staging and the test ones). So every source set was suppressed and each module reached the generator with sourceSets=[] ("Nothing to document").

The fix keeps the release source set, suppresses the rest (they all document the same src/main/java, and one set keeps source-link merging unambiguous) and labels it android in the rendered pages. Same task, same output directory, so the workflow and the site layout are unchanged.

Type of Change

  • Bug fix
  • Feature
  • Documentation
  • Refactor or cleanup
  • CI/build/release
  • Breaking change

Affected Areas

  • API module
  • Player module
  • Camera recording/upload module
  • Android TV module
  • Demo app
  • Documentation
  • Build or publishing

Testing

  • ./gradlew testDebugUnitTest --no-daemon --stacktrace - :player re-run green after the change (build-script only)
  • ./gradlew :app:assembleDebug --no-daemon
  • Manual playback/upload/recording test
  • Not run, reason: no runtime code changed

./gradlew dokkaGeneratePublicationHtml: 1168 HTML pages (api 737, player 365, recording 64), root index lists the three modules with their Module.md blurbs, BunnyStreamApi / BunnyStreamPlayer / BunnyLiveStreamPlayer / StreamCameraUploadView pages present, no org.openapitools pages, 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

  • No substantial AI assistance was used.
  • AI helped with this PR; I reviewed and understand the final changes.

Checklist

  • The PR is focused on one clear change.
  • Public API or behavior changes are documented.
  • Tests or manual verification are included where appropriate.
  • No secrets, access keys, or private data are included.

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
damwilin force-pushed the fix/dokka-empty-reference branch from 33b6be8 to 033d810 Compare September 9, 2026 16:02
@bogdan-at-bunny
bogdan-at-bunny merged commit 6118838 into main Sep 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants