Dokka 2+: Creating a custom format requires access to an internal configuration

[CLOVIS-AI]

trafficstars

Is your feature request related to a problem? Please describe

I am creating a custom Dokka output format. More specifically, I'm embedding Dokka into an MkDocs website.

Since I created a custom format, Dokka generates a task that creates all the files. But I need them to be in a specific directory. I want to recursively access all generated files.

At the moment, the best way to do so seems to be to declare a dependency on the configuration dokkaMkdocsModuleOutputDirectoriesResolver~internal, which I do here and is used in the Sync task declared just below.

Describe the solution you'd like

A way to access all the files that were outputted by my custom format, across any project registered in the current project through dependencies { dokka(…) }.

Describe alternatives you've considered

I don't know what's possible here.

[adam-enko]

Hi, thanks for the request.

I see the difficulty, and while I don't have the time right now to have a thorough look, I have a suggestion: Could you try accessing the files from the DokkaFormatPluginContext instead?

abstract class DokkaMkDocsPlugin : DokkaFormatPlugin(formatName = "mkdocs") {

    @OptIn(DokkaInternalApi::class)
    override fun DokkaFormatPluginContext.configure() {
        val moduleOutputFiles = formatDependencies.moduleOutputDirectories.incomingArtifactFiles

        // ...
    }

    // ...
}

[CLOVIS-AI]

DokkaFormatPlugin doesn't seem to have a configure method that I can override? I'm a bit confused

[adam-enko]

DokkaFormatPlugin doesn't seem to have a configure method that I can override? I'm a bit confused

Hmm strange, it should be there, both in Dokka and Dokkatoo

• https://github.com/Kotlin/dokka/blob/a2fe93492409054bdc754ef6b935f4e2f00ca4f1/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatPlugin.kt#L147-L148
• https://github.com/adamko-dev/dokkatoo/blob/07c697e0b3864110ddeedec761089b2d4aa49e87/modules/dokkatoo-plugin/src/main/kotlin/formats/DokkatooFormatPlugin.kt#L144-L145

Could you share more info? Do you get an error message?

[CLOVIS-AI]

Weird. Just IDEA that says there is no method to override. I tried to copy-paste your snippet in this file, I don't know where else it could be?

[adam-enko]

I see the method is already overridden https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/blob/main/dokka-mkdocs/src/main/kotlin/DokkaMkDocsPlugin.kt?ref_type=heads#L118-123, so I guess it's a very unhelpful error message from IJ?

[CLOVIS-AI]

uh, I'm dumb. Thanks, I'll try it again then :|

[adam-enko]

I've removed this from the 2.1.0 milestone because we want to focus on releasing DGPv2 as default, and this issue has a workaround (opt-in to DokkaInternalApi).