From 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Thu, 19 Jan 2023 04:10:57 +0100 Subject: Revise README documentation for examples and plugins (#2736) --- .../gradle/dokka-multimodule-example/README.md | 25 ++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 examples/gradle/dokka-multimodule-example/README.md (limited to 'examples/gradle/dokka-multimodule-example/README.md') diff --git a/examples/gradle/dokka-multimodule-example/README.md b/examples/gradle/dokka-multimodule-example/README.md new file mode 100644 index 00000000..c8b224ec --- /dev/null +++ b/examples/gradle/dokka-multimodule-example/README.md @@ -0,0 +1,25 @@ +# Dokka MultiModule example + +This example demonstrates how to apply and configure Dokka in a +[multi-project build](https://docs.gradle.org/current/userguide/multi_project_builds.html). + +You can also learn how to set Dokka's version in [gradle.properties](gradle.properties) using `pluginManagement` +configuration block in [settings.gradle.kts](settings.gradle.kts). + +____ + +You can see up-to-date documentation generated for this example on +[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-multimodule-example/htmlMultiModule/index.html). + +![screenshot demonstration of output](demo.png) + +### Running + +Run `dokkaHtmlMultiModule` task to generate documentation for this example: + +```bash +./gradlew dokkaHtmlMultiModule +``` + +It will generate complete documentation for the root project and its subprojects, with a common +Table of Contents. -- cgit