The docs state: ``` // Allows linking to documenta...

# dokka

[raulraja]

The docs state:

// Allows linking to documentation of the project's dependencies (generated with Javadoc or Dokka)
    // Repeat for multiple links
    externalDocumentationLink {
        // Root URL of the generated documentation to link with. The trailing slash is required!
        url = new URL("<https://example.com/docs/>")
        
        // If package-list file located in non-standard location
        // packageListUrl = new URL("file:///home/user/localdocs/package-list") 
    }

And package-list is briefly mentioned. Isn't each module responsible for generating a package-list or how does a user instruct dokka to generate one for a given module that others can consume locally or remotely?

Are there other docs for Dokka beside
https://github.com/Kotlin/dokka#dokka-----
https://kotlinlang.org/docs/reference/kotlin-doc.html
?

We rely on dokka to generate the Arrow documentation and currently there is a bunch of places where it's unable to link referenced types from other modules. For example https://arrow-kt.io/docs/apidocs/arrow-mtl/arrow.mtl.extensions.option.functor-filter/arrow.-kind/index.html contains no link to Option because it's in a different module: https://arrow-kt.io/docs/apidocs/arrow-core-data/arrow.core/-option/index.html

[semoro]

There is a docs on Dokka in Dokka repo on github:
https://github.com/Kotlin/dokka
Small wiki: https://github.com/Kotlin/dokka/wiki/faq#dokka-complains-about-cant-find-node-by-signature-

Basically you could link using the URL + packageListUrl

So, you have to provide online url of module to url parameter of external link, and
local url to packageListUrl parameter

[semoro]

Something like that

dokka {
    classpath = configurations.compile
    externalDocumentationLink {
      url = new URL("<http://example.com/project-a/>")   
      packageListUrl = new URL("file://${project(":projectA").buildDir}/dokka/projectA/package-list")
    }
}

[raulraja]

thanks Simon, will check that out.