stig-gradle-plugin/com.stigway.gradle.config/dokkaAggregatePackageDepth

dokkaAggregatePackageDepth

fun dokkaAggregatePackageDepth(dokkaModuleName: String): Int

Number of directory levels from the Dokka HTML root (build/dokka/html/) to a package-level page rendered by Dokka's aggregate HTML publication.

Dokka aggregate layout:

html/                                           ← root (images/ lives here)
  {module/path/segments}/                       ← module name dots → nested dirs
    {package.name.with.dots}/                   ← single flat directory per package
      index.html                                ← the page we're computing depth for

So the depth = number of segments in the module name + 1 (for the flat package dir).

Parameters

dokkaModuleName

the dotted module name (e.g. activities.aeb.fusion_activity) as returned by stigDokkaModuleName.