Added docs command
This commit is contained in:
parent
a48a5d99fd
commit
50ae7438b0
2 changed files with 14 additions and 0 deletions
|
@ -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
|
||||
|
|
|
@ -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()
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue