search

Kotlin / dokka

API documentation engine for Kotlin
https://kotl.in/dokka
Apache License 2.0
3.38k stars 399 forks source link

Nested multi module navigation #1888

Open rnett opened 3 years ago

rnett commented 3 years ago

Is your feature request related to a problem? Please describe I have a multi module project with several layers. The directory structure looks like this:

krosstalk (root)
    core
        krosstalk
        krosstalk-client
        krosstalk-server
    ktor
        krosstalk-ktor-client
        krosstalk-ktor-server

Currently, a multi module build of the root project results in all of the leaf modules being at the same level, i.e.: image

Describe the solution you'd like I would like to be able to nest the modules, so the navigation would look something like

Krosstalk (from core)
    Krosstalk
    Krosstalk Client
    Krosstalk Server
Ktor
    Krosstalk Ktor Client
    Krosstalk Ktor Server

I have tried including a multi-module task in the ktor project, but it didn't work. I assume doing this is impossible currently.

jacobzhang1979 commented 11 months ago

Dear @IgnatBeresnev

Can we prioritize this issue as it is very helpful to have neat and well-structured html doc if Dokka can produce for us, the same as porject code structure.

I do think most of mordern projects will have nested mutil-modules structure.

Regards