Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings
This repository was archived by the owner on Jan 22, 2024. It is now read-only.

Commit 8fd3982

Browse files
MarcinAmanzarechenskiy
authored andcommitted
Update Dokka to 1.4.20, add CI for dokka
1 parent 2011200 commit 8fd3982

File tree

16 files changed

+148
-45
lines changed

16 files changed

+148
-45
lines changed

‎.github/workflows/dokka-examples.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: CI
2+
3+
on: pull_request
4+
5+
jobs:
6+
build:
7+
strategy:
8+
matrix:
9+
projects: [
10+
gradle/dokka/dokka-gradle-example,
11+
gradle/dokka/dokka-kotlinAsJava-example,
12+
gradle/dokka/dokka-library-publishing-example,
13+
gradle/dokka/dokka-multimodule-example,
14+
gradle/dokka/dokka-multiplatform-example,
15+
gradle/dokka/dokka-customFormat-example
16+
]
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v2
20+
- uses: actions/setup-java@v1
21+
with:
22+
java-version: 11
23+
- run: ./gradlew build --no-daemon --stacktrace
24+
working-directory: ${{ matrix.projects }}
25+
26+
run-dokka-html:
27+
strategy:
28+
matrix:
29+
projects: [
30+
gradle/dokka/dokka-gradle-example,
31+
gradle/dokka/dokka-kotlinAsJava-example,
32+
gradle/dokka/dokka-library-publishing-example,
33+
gradle/dokka/dokka-multiplatform-example,
34+
gradle/dokka/dokka-customFormat-example
35+
]
36+
runs-on: ubuntu-latest
37+
steps:
38+
- uses: actions/checkout@v2
39+
- uses: actions/setup-java@v1
40+
with:
41+
java-version: 11
42+
- run: ./gradlew dokkaHtml --no-daemon --stacktrace
43+
working-directory: ${{ matrix.projects }}
44+
45+
run-dokka-multimodule:
46+
runs-on: ubuntu-latest
47+
steps:
48+
- uses: actions/checkout@v2
49+
- uses: actions/setup-java@v1
50+
with:
51+
java-version: 11
52+
- run: ./gradlew dokkaHtmlMultiModule --no-daemon --stacktrace
53+
working-directory: gradle/dokka/dokka-multimodule-example
54+
55+
run-dokka-publishing:
56+
strategy:
57+
matrix:
58+
tasks: [dokkaJavadocJar, dokkaHtmlJar]
59+
runs-on: ubuntu-latest
60+
steps:
61+
- uses: actions/checkout@v2
62+
- uses: actions/setup-java@v1
63+
with:
64+
java-version: 11
65+
- run: ./gradlew ${{ matrix.tasks }} --no-daemon --stacktrace
66+
working-directory: gradle/dokka/dokka-library-publishing-example
67+
68+
run-dokka-custom-format:
69+
runs-on: ubuntu-latest
70+
steps:
71+
- uses: actions/checkout@v2
72+
- uses: actions/setup-java@v1
73+
with:
74+
java-version: 11
75+
- run: ./gradlew dokkaCustomFormat --no-daemon --stacktrace
76+
working-directory: gradle/dokka/dokka-customFormat-example
77+
78+
run-dokka-maven-example:
79+
runs-on: ubuntu-latest
80+
steps:
81+
- uses: actions/checkout@v2
82+
- uses: actions/setup-java@v1
83+
with:
84+
java-version: 11
85+
- run: mvn compile dokka:dokka
86+
working-directory: maven/dokka-maven-example

‎gradle/dokka/dokka-customFormat-example/build.gradle.kts

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
import org.jetbrains.dokka.gradle.DokkaTask
22

33
plugins {
4-
kotlin("jvm") version "1.4.0"
5-
id("org.jetbrains.dokka") version ("1.4.0")
4+
kotlin("jvm") version "1.4.20"
5+
id("org.jetbrains.dokka") version ("1.4.20")
6+
}
7+
8+
buildscript {
9+
repositories {
10+
jcenter()
11+
}
12+
dependencies {
13+
classpath("org.jetbrains.dokka:dokka-base:1.4.20")
14+
}
615
}
716

817
repositories {
@@ -12,10 +21,13 @@ repositories {
1221
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
1322
}
1423

24+
/**
25+
* Custom format adds a custom logo
26+
*/
1527
tasks.register<DokkaTask>("dokkaCustomFormat") {
16-
dependencies {
17-
// Using the javadoc plugin as "custom format". Can use any plugin here!
18-
plugins("org.jetbrains.dokka:javadoc-plugin:1.4.0")
28+
pluginConfiguration<org.jetbrains.dokka.base.DokkaBase, org.jetbrains.dokka.base.DokkaBaseConfiguration> {
29+
customStyleSheets =listOf(file("logo-styles.css"))
30+
customAssets =listOf(file("ktor-logo.png"))
1931
}
2032
}
2133

175 KB
Loading[フレーム]
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#logo {
2+
background-image: url('../images/ktor-logo.png');
3+
background-size: 125px 50px;
4+
padding-top: 12px;
5+
height: 65px;
6+
}

‎gradle/dokka/dokka-gradle-example/build.gradle.kts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import org.jetbrains.dokka.gradle.DokkaTask
22
import java.net.URL
33

44
plugins {
5-
kotlin("jvm") version "1.4.0"
6-
id("org.jetbrains.dokka") version ("1.4.0")
5+
kotlin("jvm") version "1.4.20"
6+
id("org.jetbrains.dokka") version ("1.4.20")
77
}
88

99
repositories {
@@ -21,7 +21,7 @@ dependencies {
2121
tasks.withType<DokkaTask>().configureEach {
2222
dokkaSourceSets {
2323
named("main") {
24-
moduleDisplayName.set("Dokka Gradle Example")
24+
moduleName.set("Dokka Gradle Example")
2525
includes.from("Module.md")
2626
sourceLink {
2727
localDirectory.set(file("src/main/kotlin"))

‎gradle/dokka/dokka-kotlinAsJava-example/build.gradle.kts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
2-
kotlin("jvm") version "1.4.0"
3-
id("org.jetbrains.dokka") version ("1.4.0")
2+
kotlin("jvm") version "1.4.20"
3+
id("org.jetbrains.dokka") version ("1.4.20")
44
}
55

66
repositories {
@@ -15,11 +15,11 @@ dependencies {
1515
testImplementation(kotlin("test-junit"))
1616

1717
// Will apply the plugin to all dokka tasks
18-
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0")
18+
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.20")
1919

2020
// Will apply the plugin only to the `:dokkaHtml` task
21-
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0")
21+
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.20")
2222

2323
// Will apply the plugin only to the `:dokkaGfm` task
24-
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0")
24+
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.20")
2525
}

‎gradle/dokka/dokka-library-publishing-example/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
plugins {
2-
kotlin("jvm") version "1.4.0"
3-
id("org.jetbrains.dokka") version ("1.4.0")
2+
kotlin("jvm") version "1.4.20"
3+
id("org.jetbrains.dokka") version ("1.4.20")
44
`java-library`
55
`maven-publish`
66
}

‎gradle/dokka/dokka-multimodule-example/parentProject/build.gradle.kts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,3 @@ dependencies {
1818
implementation(kotlin("stdlib"))
1919
}
2020

21-
/**
22-
* Configuring the html multimodule task
23-
* Run ./gradlew :parentProject:dokkaHtmlMultimodule
24-
*/
25-
tasks.dokkaHtmlMultiModule {
26-
documentationFileName.set("Module.md")
27-
}
28-

‎gradle/dokka/dokka-multimodule-example/settings.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
pluginManagement {
22
plugins {
3-
kotlin("jvm") version "1.4.0"
4-
id("org.jetbrains.dokka") version ("1.4.0")
3+
kotlin("jvm") version "1.4.20"
4+
id("org.jetbrains.dokka") version ("1.4.20")
55
}
66
repositories {
77
gradlePluginPortal()

‎gradle/dokka/dokka-multiplatform-example/build.gradle.kts

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import org.jetbrains.dokka.gradle.DokkaTask
44
import org.jetbrains.dokka.Platform
55

66
plugins {
7-
kotlin("multiplatform") version "1.4.0"
8-
id("org.jetbrains.dokka") version "1.4.0"
7+
kotlin("multiplatform") version "1.4.20"
8+
id("org.jetbrains.dokka") version "1.4.20"
99
}
1010

1111
repositories {
@@ -33,21 +33,13 @@ kotlin {
3333

3434
tasks.withType<DokkaTask>().configureEach {
3535
dokkaSourceSets {
36-
/*
37-
Giving all 'native' source sets the same name will make them displayed by a single bubble.
38-
*/
39-
configureEach {
40-
if (platform.get() == Platform.native) {
41-
displayName.set("native")
42-
}
43-
}
4436
/*
4537
Create custom source set (not known to the Kotlin Gradle Plugin)
4638
*/
4739
register("customSourceSet") {
4840
this.jdkVersion.set(9)
4941
this.displayName.set("custom")
50-
this.sourceRoots.from(file("src/customJdk10/kotlin"))
42+
this.sourceRoots.from(file("src/customJdk9/kotlin"))
5143
}
5244
}
5345
}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /