diff options
Diffstat (limited to 'examples/gradle/dokka-gradle-example/README.md')
| -rw-r--r-- | examples/gradle/dokka-gradle-example/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/examples/gradle/dokka-gradle-example/README.md b/examples/gradle/dokka-gradle-example/README.md new file mode 100644 index 00000000..3401e8e9 --- /dev/null +++ b/examples/gradle/dokka-gradle-example/README.md @@ -0,0 +1,22 @@ +# Dokka Gradle example + +This example demonstrates how to apply Dokka in a simple single-project Gradle build, as well as how to configure it. + +Configuration changes: + +* Custom project name used in the header, `Dokka Gradle Example`. +* Description for the project and the packages taken from [Module.md](Module.md). +* Documentation contains source links that lead to declarations in this GitHub repository. + +You can see up-to-date documentation generated for this example on +[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-gradle-example/html/index.html). + + + +### Running + +Run `dokkaHtml` task to generate documentation for this example: + +```bash +./gradlew dokkaHtml +``` |