i am trying to use `include` via `dokkaSourceSets`...

# dokka

[Sam Gammon]

i am trying to use include via dokkaSourceSets, but i can't quite get it to work. code:

tasks.withType<org.jetbrains.dokka.gradle.DokkaTaskPartial>().configureEach {
    dokkaSourceSets {
        configureEach {
            includes.from("module.md")
        }
    }
}

[Ignat Beresnev]

Hiya! Where is the file located? If it's a multimodule project, by default it'll look for the file in the root of the module

You can try providing the absolute path to make sure that's the problem

[Ignat Beresnev]

And can you paste file contents here please? I don't remember for sure, but if it doesn't fail the build then it must see the file

There's also an example you can have a look at: https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example

[Sam Gammon]

@Ignat Beresnev if i tweak the filename it fails the build, so i know it is finding the markdown file

[Sam Gammon]

here's the file contents:

[Sam Gammon]

# Module `base`

Module docs here

[Sam Gammon]

i've built it from that sample

[Ignat Beresnev]

Pretty sure the problem is with the header, try removing backticks, the example doesn't have any

https://raw.githubusercontent.com/Kotlin/dokka/master/examples/gradle/dokka-multimodule-example/parentProject/childProjectB/Module.md

[Sam Gammon]

@Ignat Beresnev good idea but i'm not seeing any change 😞

[Sam Gammon]

Screenshot 2022-11-12 at 3.12.24 PM.png

[Sam Gammon]

that's the module which has a module.md

[Sam Gammon]

it should be appearing between server and Packages, right? if i try to navigate to module.html it gives me a 404

[Ignat Beresnev]

No, module.md is not rendered like a separate page. Instead, it's parsed and the descriptions from it are rendered alongside module and package names

[Ignat Beresnev]

There's a bit of documentation for the format on kotlinlang: https://kotlinlang.org/docs/kotlin-doc.html#module-and-package-documentation

Example from dokka-gradle-example:

# Module Dokka Gradle Example

This is an example of how you can write module documentation with Dokka.

# Package demo

This package contains a few examples of Dokka usage.

[Sam Gammon]

@Ignat Beresnev i think the backticks fixed it! it seemed like it didn't at first, but now it's working great

[Sam Gammon]

i think i may have changed it in the wrong module and so my test was invalid

[Sam Gammon]

thank you for your help here!