I don't understand how the all-modules-page plugin works. Looking at the source of the

org.jetbrains.dokka.gradle.formats.DokkaHtmlPlugin

, there is a check but no configuration at all. The Javadoc plugin doesn't aggregate modules, and the other formats haven't been migrated to the Gradle plugin?

Is there an easy way to parameterize Dokka module documentation? I have a section of my docs that looks something like this in the getting started section:

[versions]
cardiologist = "0.3.1"

[libraries]
cardiologist = { module = "io.github.kevincianfarini.cardiologist:cardiologist", version.ref = "cardiologist" }

I want to parameterize the version number

0.3.1

so that I can inject it from my

gradle.properties

file. Is that possible?

Hi, I've upgraded version of Jackson in our project and dokka plugin stopped working. It says

* What went wrong:
Execution failed for task ':app:dokkaGeneratePublicationHtml'.
> A failure occurred while executing org.jetbrains.dokka.gradle.workers.DokkaGeneratorWorker
   > 'void com.fasterxml.jackson.databind.type.TypeFactory.<init>(com.fasterxml.jackson.databind.util.LRUMap)'

I tried this workaround to force dokka to use older Jackson, but it seems it does not work. https://github.com/Kotlin/dokka/issues/3472#issuecomment-2244628081 Any idea how to solve it?

Hi is there a way to load the child projects' custom assets to the root in dokka multi module? Seems like when there's a multi module configuration applied, the assets from the child projects defined with

dokka(projects.x.y.z)

is not loaded along with it.

Hello! I'm configuring dokka currently and wanted to include the changelog file in my generated HTML I have this at the root

build.gradle.kts

:

subprojects {
  apply("com.dokka...")

  afterEvaluate {
    dokka {
     dokkaPublications.html {
      moduleName.set("SOME - " + project.name)
      includes.from(project.layout.projectDirectory.file("CHANGELOG.md"))
     }
    }
  }
}

The file is at the correct location for each subproject, but I don't see my changelog file when I execute

./gradlew dokkaGenerate

Is there anything missing ? Is that something that's possible? Thanks! 🙂

Also on another note... I generate that documentation for a library. I would like to exclude all code that is

internal

in each of my modules since it's not visible for anyone using the library? Thanks again!

Hi all. I'm reading over changes for 2.0.0 and have a question about multi-module projects. How do you share Dokka configuration across modules and aggregate documentation from all of the modules? I've tried doing it this way in dokka-convention.gradle.kts, but it doesn't aggregate.

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

dokka {
    dokkaSourceSets.configureEach {
        reportUndocumented = false
        skipEmptyPackages = false
        skipDeprecated = true
    }

    dokkaPublications.html {
        outputDirectory.set(layout.buildDirectory.dir("docs"))
    }
}

dependencies {
    dokka(project(":project1"))
    dokka(project(":project2"))
}

And in each modules build.gradle.kts

plugins {
  id("dokka-convention")
}

Ok got that working. Can you inject your own content in there, such as a getting started markdown file without having to do

# Package

or

# Module

?

I'm migrating to Dokka v2, and after reading the migration steps there is still one point that's unclear. I currently have

dokkaHtmlPartial {
  dependsOn(generateKotlinGrammarSource) // ANTLR task
}

in my sub-module build script. What's the correct task to use in place of

dokkaHtmlPartial

for this specific case?

Is it expected in v2 to see

> Task :module-name:logLinkDokkaGeneratePublicationHtml
Generated Dokka HTML publication: localhost URL

for every sub-module, even when I'm running

dokkaGenerate

at the top level with aggregation?

Sharing my immediate feedback after the migration. 1. Setting a custom logo also required overwriting some CSS properties, otherwise the logo was stretched horizontally.

.library-name--link::before {
  background-size: var(--dokka-logo-height) var(--dokka-logo-width);
  max-height: unset;
  max-width: unset;
}

2. The sidebar paddings are bit too much imo. 3. The hover highlight appears only on the package name or the toggle arrow, but not on both at the same time (is it intended?)

Hello! I wanted to know if there is a simple way to add custom markdown files. Like there is the kdoc, and I want to add an example/tutorial section in the menu, imported from markdown files (would seem to be the easiest option) There has to be an option or plugin for this (otherwise I’m making a plugin for it)

Hopefully a quick question. I'm converting a kotlin multi-platform (KMP) library project to Dokka 2. I'm having trouble getting the HTML generated, and the doc at Dokka V 2.0 migration guide looks incorrect. It claims that this should be valid in the dokka block in build.gradle.kts:

dokkaPublications.html {

outputDirectory.set(rootDir.resolve("docs/api/0.x"))

includes.from(project.layout.projectDirectory.file("README.md"))

}

but when I try this the html clause is an unresolved reference (using Idea 2025.2 EAP). And using the snippet below the builds/dokka folder has only an empty javadoc subfolder, so nothing is being generated. Since this is KMP I know V 2.0.0 doesn't support the javadoc option. What do I need to add to get the HTML to generate? Here's my beginning dokka snippet:

dokka {
    moduleName.set("Kotlin Multiplatform Common IO Library")
    dokkaSourceSets.commonMain {
        includes.from("$appleFrameworkName.md")
    }
}

Also, as a followup, I've struggled to find an example of how to tell maven publish to publish the HTML once generated. I'd also appreciate any info on that. Thanks in advance for any help...

Hello! I saw this stale PR about sitemaps in Dokka. Is there any plan about it? I would love to see the feature, and can help if needed https://github.com/Kotlin/dokka/pull/2009

While diagnosing a publishing issue on my KMP project, I ran a gradle publish task with --info. The project is using

applyDefaultHierarchyTemplate()

so all the sourceSet names fit that template. Dokka produced a number of messages that surprised me, as if it doesn't understand the default hierarchy template. I posted the messages as a reply in this thread. Basically all the source sets that aren't leaf nodes in the default template are getting labeled as common. That seems to lead to it generating doc from appleMain into all the platforms, not just the Apple ones, etc. Is this expected behavior?

I am a dokka newbie ... struggling to get dokka 2.0.0 configured in IntelliJ 2024.3.6 on macOS Setting up from scratch ... not a migration. I am following documentation at https://kotlinlang.org/docs/dokka-get-started.html https://kotlinlang.org/docs/dokka-gradle.html#single-project-configuration ... but failing ... tasks are undefined If I try the other single-project configuration then the imports are undefined. I am able and willing to help improve for other newbies coming up.

I’m generating HTML documentation from auto-generated java files and I’m not seeing markdown syntax being recognized. Here’s an example of the generated file:

/**
 * This is a new interface for testing dokka.
 *
 * This should be a new line
 *
 * And [this](<https://www.google.com/>) should be a hyperlink.
 */
@Keep
public abstract class NewInterface {
    /** [This](<https://www.google.com/>) should also be a hyperlink. */
    public abstract void foo();

And attached is the generated HTML. Neither the new lines or hyperlinks are being recognized. Am I using the right syntax? Any ideas for solutions (or workarounds)? I’m using dokka version 2.0.0

Hi 🙂 This week I configured dokka on a project. I spent like an hour tweaking Gradle trying to figure out why the side bar was empty. It turns out one needs to load the html via a web server. Double clicking on

index.html

leaves the side bar empty. Something that would have saved me some frustration is including a

<!-- please load via a web server -->

HTML comment where the list should show up.

Hi, I upgraded dokka plugin to 2.0 in this commit: https://github.com/oshai/kotlin-logging/commit/c6598126edfd0c8662a736d4023975928cfdf520 it seems the docs site was generated but all links are broken (clicking a class get 404) https://oshai.github.io/kotlin-logging/

Is there a way to link to other modules from module documentation? I've tried KDoc-style links to the module name (

[my-module]

), relative links to the directory (

[my-module](./my-module)

), and relative HTML links (

[my-module](../my-module/index.html)

), none of which work. The second two are rendered as the link address rather than being links.

Has anyone faced/resolved issues with Dokka V2 multi-module Javadoc generation? The HTML generation works for my composite build dependencies, but Javadoc generation produces empty directories.

Hi, I am working on library that is using Jetpack Compose. Is there any way on how to display components using @sample annotation in KDoc? I am getting an error “Unresolved reference ‘androidx’” in interactive preview

🚀 Dokka 2.1.0-Beta is out! 🚀 • Gradle plugin v2 is now enabled by default – v1 is deprecated and will be removed in future releases! • K2 analysis is enabled by default – now with the support for context parameters! • Refined HTML output with improved accessibility & UI. • Performance improvements and bug fixes. We would really appreciate your feedback! kodee loving

Hello! I'd like to use Dokka in an Android library project to generate completely independent HTML sites for each build variant, as these variants have differences in their exposed API. I know how to do that using Dokka V1. I can declare a new Task for each Android variant I'm interested in, make it a

DokkaTask

, and suppress the source sets I'm not interested in. How would I achieve this with V2, as registering Dokka tasks now seems to be unsupported?

Hello team, I am trying to customise our dokka usage a bit to make it more usable for our customers. Here are a few things I am trying to achieve: 1. bring back constructor arguments for enum entries ref where it got removed 2. have the arguments of the entries appear in the search 3. insert an additional page that collects information from multiple pages into a single, more concise collections. I am trying to achieve above by writing a custom plugin, which I managed to set up for basic functionality thanks to the help of the available documentation. 🎉 I am now struggling mainly with extracting the constructor arguments from the enum entries. My understanding is that this would have to happen in

DefaultSymbolToDocumentableTranslator

as this seems to be the only place that still has access to this kind of information but it does not seem to be extendible by plugins without having to copy/rewrite the whole thing. Would someone have any suggestions as to how this could be achieved?

Hello! I’m migrating to Dokka v2 (2.0.0/2.1.0-Beta), and when I use

./gradlew dokkaGenerate

in multi-module project, with:

dependencies {
    dokka(project(":module-a"))
    dokka(project(":module-b"))
}

Everything is generated as expected. Unfortunately, the root - http://localhost:63342/MyProject/build/dokka/html/index.html -

index.html

and

navigation.html

only show the first module. If I open the file (not using localhost) I can navigate between modules because the

index.html

shows “All modules” but the

navigation.html

is not rendered. If I open the

navigation.html

file, the links for each module are correct. Any help?

Dokka for MkDocs 0.5.3 is out! Dokka for MkDocs is an experimental new format for Dokka, allowing to embed your Dokka output seamlessly into a MkDocs website. Documentation • Visit the demo! • #C078Z1QRHL3

Hey folks. I'm testing out a possible migration from dokkatoo to dokka 2.0, and I'm experiencing an issue with using the Dokka Gradle plugin, where my convention plugin is not recognizing a

DokkaExtension

despite applying

org.jetbrains.dokka

. Is there something I'm not doing correctly?

hey, I'm having some issues with dokka producting very inconsistent behaviour. on my machine, dokka is producing the correct output. previously, on CI dokka was also producing the correct output. however for some reason, a recent change has caused dokka to no longer produce the output on CI, but it's still producing the correct output on my machine. here is an example of the expected output: https://ci.solo-studios.ca/job/solo-studios/job/kt-fuzzy/job/master/13/javadoc/kt-string-similarity/index.html here is an example of the incorrect output produced by CI: https://ci.solo-studios.ca/job/solo-studios/job/kt-fuzzy/job/master/14/javadoc/kt-string-similarity/index.html the commit in question which caused it was this: https://github.com/solo-studios/kt-fuzzy/commit/65587a03e1d38012fea9477bd0764a843c70dd54 however, I don't see how that affected it, so I'm just going to assume that it triggered some kind of funky thing to happen with the cache? I've got absolutely no clue why it's doing this.

🚀 Dokka 2.1.0 release is out! 🚀 This version focuses on stabilizing experimental features, supporting new Kotlin language features, and improving the user experience. Key highlights include: • Dokka Gradle Plugin v2 is now enabled by default! • K2 Analysis is enabled by default! • Support for Context parameters and Nested typealiases • HTML format refinement: better accessibility and consistency across all components • Multiple performance and compatibility improvements We would really appreciate your feedback! kodee loving