Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Html: Modules with same short name but different path (full name) override each other #2437

Closed
hfhbd opened this issue Apr 13, 2022 · 4 comments
Labels

Comments

@hfhbd
Copy link
Contributor

hfhbd commented Apr 13, 2022

Describe the bug
I have a project with nested modules. The module names are the same, but they are always in different sub modules.

| - a
| - - foo
| - b
|- - foo

Expected behaviour
two different modules, a.foo and b.foo

Screenshots
Bildschirmfoto 2022-04-13 um 16 06 22

To Reproduce
untitled3.zip

./gradlew dokkaHtmlMultiModule

Workaround

// root build.gradle.kts
subprojects {
    tasks.getByName<DokkaTaskPartial>("dokkaHtmlPartial") {
        moduleName.set(project.path.drop(1).replace(":", " "))
    }
}

Dokka configuration
Nothing special:

// root build.gradle.kts
plugins {
    kotlin("jvm") version "1.6.20" apply false
    id("org.jetbrains.dokka") version "1.6.10"
}

// settings.gradle.kts
include(":a:foo")
include(":b:foo")

// a.foo/b.foo build.gradle.kts
plugins {
    kotlin("jvm")
    id("org.jetbrains.dokka")
}

Installation

  • Operating system: macOS
  • Build tool: Gradle v7.4.2
  • Dokka version: 1.6.10

Are you willing to provide a PR?
With help, sure.

@hfhbd hfhbd added the bug label Apr 13, 2022
@IgnatBeresnev
Copy link
Member

Thanks for the report!

Unfortunately, this is a known issue, duplicates are #2037, #2272, #2413

Hopefully, it'll be addressed soon

@hfhbd
Copy link
Contributor Author

hfhbd commented Apr 13, 2022

Oh, I used the wrong search terms.
With multi modules a tree based navigation sidebar would be helpful too.

@Jeffset
Copy link

Jeffset commented Apr 25, 2022

Well, the problem is deeper than we think. The Gradle itself has the same issue - gradle/gradle#847. Had it for years now. So, basically, it prevents anybody from naming their subprojects in a way so they share a short name.

@IgnatBeresnev
Copy link
Member

Closing this as duplicate of #2272 to reduce spreading information in different issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants