dokka icon indicating copy to clipboard operation
dokka copied to clipboard

How do I configure `dokkaHtmlMultiModule` task to include or exclude specific modules from doc generation?

Open hossain-khan opened this issue 1 year ago • 0 comments

Question How do I configure dokkaHtmlMultiModule task to include or exclude specific modules from kDoc generation?

For example the task is defined as:

tasks.dokkaHtmlMultiModule {
  outputDirectory.set(... "docs/kdocs")
  includes.from(... "README.md")
}

I wasn't able to find a configuruation to include specific modules out of 100+ modules to generate kDoc for in following documentation example

  • https://kotlinlang.org/docs/dokka-gradle.html#source-set-configuration

Installation

  • Operating system: macOS & Linux
  • Build tool: Gradle 8.6, Kotlin: 1.9.20, JVM: 21.0.1
  • Dokka version: 1.9.10

Additional context Generating all module creates 15GB+ HTML content, which is the reason to only generate selective modules which likely will take less than 30MB space.

hossain-khan avatar Feb 17 '24 17:02 hossain-khan