Skip to content

Commit 315fd22

Browse files
committed
Add dokka generation
1 parent d86c5a0 commit 315fd22

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

README.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,21 @@ All of it makes multi-process communication smooth enough to recognize remote se
100100
* Load balancing: task is done, request new via client's lambda.
101101
* Stateful streaming computations: nodes provide theirs lambdas for a mapper.
102102

103+
== Getting started
104+
105+
.Run detekt
106+
[source,bash]
107+
----
108+
$ ./gradlew :lambdarpc:detekt
109+
----
110+
111+
.Generate documentation
112+
[source,bash]
113+
----
114+
$ ./gradlew :lambdarpc:dokkaHtml
115+
$ cd ./lambdarpc/build/dokka/html
116+
----
117+
103118
=== Repository organization
104119

105120
.examples

lambdarpc/build.gradle.kts

+8
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ plugins {
1111
kotlin("plugin.serialization") version "1.6.10"
1212
id("com.google.protobuf") version "0.8.18"
1313
id("io.gitlab.arturbosch.detekt") version "1.19.0"
14+
id("org.jetbrains.dokka") version "1.6.10"
1415
}
1516

1617
tasks.withType<KotlinCompile>().all {
@@ -38,6 +39,13 @@ dependencies {
3839
testImplementation("org.junit.jupiter:junit-jupiter")
3940
}
4041

42+
tasks.withType<Test> {
43+
useJUnitPlatform()
44+
testLogging {
45+
events("passed", "skipped", "failed")
46+
}
47+
}
48+
4149
protobuf {
4250
protoc {
4351
artifact = "com.google.protobuf:protoc:3.19.1"

0 commit comments

Comments
 (0)