Skip to content

Commit dccfa35

Browse files
chore(internal): don't generate docs (#325)
1 parent 02fd429 commit dccfa35

File tree

4 files changed

+1
-50
lines changed

4 files changed

+1
-50
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,14 @@
33
<!-- x-release-please-start-version -->
44

55
[![Maven Central](https://img.shields.io/maven-central/v/com.withorb.api/orb-java)](https://central.sonatype.com/artifact/com.withorb.api/orb-java/0.46.0)
6-
[![javadoc](https://javadoc.io/badge2/com.withorb.api/orb-java/0.46.0/javadoc.svg)](https://javadoc.io/doc/com.withorb.api/orb-java/0.46.0)
76

87
<!-- x-release-please-end -->
98

109
The Orb Java SDK provides convenient access to the Orb REST API from applications written in Java.
1110

1211
The Orb Java SDK is similar to the Orb Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.
1312

14-
The REST API documentation can be found on [docs.withorb.com](https://docs.withorb.com/reference/api-reference). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.withorb.api/orb-java/0.46.0).
13+
The REST API documentation can be found on [docs.withorb.com](https://docs.withorb.com/reference/api-reference).
1514

1615
## Installation
1716

build.gradle.kts

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,4 @@
1-
plugins {
2-
id("org.jetbrains.dokka") version "2.0.0"
3-
}
4-
5-
repositories {
6-
mavenCentral()
7-
}
8-
91
allprojects {
102
group = "com.withorb.api"
113
version = "0.46.0" // x-release-please-version
124
}
13-
14-
subprojects {
15-
apply(plugin = "org.jetbrains.dokka")
16-
}
17-
18-
// Avoid race conditions between `dokkaJavadocCollector` and `dokkaJavadocJar` tasks
19-
tasks.named("dokkaJavadocCollector").configure {
20-
subprojects.flatMap { it.tasks }
21-
.filter { it.project.name != "orb-java" && it.name == "dokkaJavadocJar" }
22-
.forEach { mustRunAfter(it) }
23-
}

buildSrc/src/main/kotlin/orb.publish.gradle.kts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
import com.vanniktech.maven.publish.JavadocJar
2-
import com.vanniktech.maven.publish.KotlinJvm
31
import com.vanniktech.maven.publish.MavenPublishBaseExtension
42
import com.vanniktech.maven.publish.SonatypeHost
53

@@ -21,12 +19,6 @@ configure<MavenPublishBaseExtension> {
2119
publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)
2220

2321
coordinates(project.group.toString(), project.name, project.version.toString())
24-
configure(
25-
KotlinJvm(
26-
javadocJar = JavadocJar.Dokka("dokkaJavadoc"),
27-
sourcesJar = true,
28-
)
29-
)
3022

3123
pom {
3224
name.set("API Reference")

orb-java/build.gradle.kts

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,3 @@ plugins {
66
dependencies {
77
api(project(":orb-java-client-okhttp"))
88
}
9-
10-
// Redefine `dokkaJavadoc` to:
11-
// - Depend on the root project's task for merging the docs of all the projects
12-
// - Forward that task's output to this task's output
13-
tasks.named("dokkaJavadoc").configure {
14-
actions.clear()
15-
16-
val dokkaJavadocCollector = rootProject.tasks["dokkaJavadocCollector"]
17-
dependsOn(dokkaJavadocCollector)
18-
19-
val outputDirectory = project.layout.buildDirectory.dir("dokka/javadoc")
20-
doLast {
21-
copy {
22-
from(dokkaJavadocCollector.outputs.files)
23-
into(outputDirectory)
24-
duplicatesStrategy = DuplicatesStrategy.INCLUDE
25-
}
26-
}
27-
28-
outputs.dir(outputDirectory)
29-
}

0 commit comments

Comments
 (0)