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.
This PR updates the build config to generates Dokka HTML API code reference for all subprojects.
To generate the API docs:
./gradlew :docs:dokkaGen
docs/build/dokka/html/index.html
in a browser.Part of #2228.
The next step is publishing the API reference to a website (e.g. GitHub Pages).
Screenshots
Here are some example screenshots.
The home page shows a list of all modules, each with a brief description (from the README.md in each subproject)
When viewing a module, all content from the module's README.md is available
Code and KDoc are easily viewable and searchable
Summary
# Module
header):docs
subprojectReasons for using Dokkatoo over the existing Dokka Gradle Plugin.
:docs
subproject. It makes sense to aggregate the API docs into this subproject. DGP cannot create an aggregated HTML doc into a subproject, while Dokkatoo can.