This example demonstrates configuration of Dokka's versioning plugin, which allows readers to navigate through different versions of your API reference documentation.
The example contains some code that exists only in the current documentation version 1.0
. You will not see
this code in the previous version 0.9
, which is located in the previousDocVersions directory.
You can see up-to-date documentation generated for this example on GitHub Pages.
Run dokkaHtmlMultiModule
task to generate documentation for this example:
./gradlew dokkaHtmlMultiModule
It will generate complete documentation for the root project and its subprojects, with the version navigation dropdown menu.