Get started with Dokka

Below you can find simple instructions to help you get started with Dokka.

Apply the Gradle plugin for Dokka in the root build script of your project:

plugins {
    id("org.jetbrains.dokka") version "1.9.20"
}

When documenting multi-project builds, you need to apply the Gradle plugin within subprojects as well:

subprojects {
    apply(plugin = "org.jetbrains.dokka")
}

To generate documentation, run the following Gradle tasks:

dokkaHtml for single-project builds
dokkaHtmlMultiModule for multi-project builds

By default, the output directory is set to /build/dokka/html and /build/dokka/htmlMultiModule.

To learn more about using Dokka with Gradle, see Gradle.

Apply the Gradle plugin for Dokka in the root build script of your project:

plugins {
    id 'org.jetbrains.dokka' version '1.9.20'
}

When documenting multi-project builds, you need to apply the Gradle plugin within subprojects as well:

subprojects {
    apply plugin: 'org.jetbrains.dokka'
}

To generate documentation, run the following Gradle tasks:

dokkaHtml for single-project builds
dokkaHtmlMultiModule for multi-project builds

By default, the output directory is set to /build/dokka/html and /build/dokka/htmlMultiModule.

To learn more about using Dokka with Gradle, see Gradle.

Add the Maven plugin for Dokka to the plugins section of your POM file:

<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.dokka</groupId>
            <artifactId>dokka-maven-plugin</artifactId>
            <version>1.9.20</version>
            <executions>
                <execution>
                    <phase>pre-site</phase>
                    <goals>
                        <goal>dokka</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

To generate documentation, run the dokka:dokka goal.

By default, the output directory is set to target/dokka.

To learn more about using Dokka with Maven, see Maven.

Last modified: 18 November 2024