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

documentationFileName no longer exists for multi-module documentation #1530

Closed
mattmook opened this issue Oct 5, 2020 · 2 comments · Fixed by #1804
Closed

documentationFileName no longer exists for multi-module documentation #1530

mattmook opened this issue Oct 5, 2020 · 2 comments · Fixed by #1804
Labels
Milestone

Comments

@mattmook
Copy link

mattmook commented Oct 5, 2020

Describe the bug
The documentation at https://github.com/Kotlin/dokka#multi-module-projects suggests being able to set documentationFileName to override the module documentation file name.

documentationFileName no longer exists in 1.4.10 - indeed searching the source code in GitHub the only references to it I can find are in the documentation. It was present in the v1.4.0 release.

Expected behaviour
documentationFileName to exist or documentation to be updated to list the correct way of changing the module documentation file names to use.

Screenshots

image

To Reproduce
Use code from documentation in your root build.gradle.kts file.

Dokka configuration
Configuration of dokka used to reproduce the bug

tasks.dokkaHtmlMultiModule.configure {
    outputDirectory.set(buildDir.resolve("dokkaCustomMultiModuleOutput"))
    documentationFileName.set("README.md")
}

Installation

  • Operating system: macOS
  • Build tool: Gradle v6.6.1
  • Dokka version: 1.4.10
@mattmook mattmook added the bug label Oct 5, 2020
@KotlinIsland
Copy link

changed here

@KotlinIsland
Copy link

02ccae1

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

Successfully merging a pull request may close this issue.

3 participants