diff --git a/README.md b/README.md index 5cfc4b2..6e99138 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,12 @@ Template for [bld](https://rife2.com/bld) projects using the [Kotlin extension]( ## Build the documentation with [Dokka](https://github.com/Kotlin/dokka) +```console +./bld docs +``` + +or any of: + ```console ./bld javadoc ./bld dokka-html diff --git a/src/bld/java/com/example/ExampleBuild.java b/src/bld/java/com/example/ExampleBuild.java index 5198fcf..d573a17 100644 --- a/src/bld/java/com/example/ExampleBuild.java +++ b/src/bld/java/com/example/ExampleBuild.java @@ -107,6 +107,14 @@ public class ExampleBuild extends Project { .execute(); } + @BuildCommand(value = "docs", summary = "Generates all documentation") + public void docs() throws ExitStatusException, IOException, InterruptedException { + dokkaGfm(); + dokkaHtml(); + dokkaJekyll(); + javadoc(); + } + @BuildCommand(value = "dokka-gfm", summary = "Generates documentation in GitHub flavored markdown format") public void dokkaGfm() throws ExitStatusException, IOException, InterruptedException { new DokkaOperation()