hey guys, I am having trouble to include a `README.md` file into dokka and can't figure it out. This...

# dokka

[cdev]

hey guys, I am having trouble to include a README.md file into dokka and can't figure it out. This is an android project, so using gradle and dokka v1.9.20.

tasks.dokkaHtml {
    dokkaSourceSets {
        configureEach {
            includes.from("../README.md")
            outputDirectory.set(file("../docs"))
        }
    }
}

where the README.md 's first line is

# Module kotlin-demo
...

After running ./gradlew dokkaHtml the docs are generated but the index.html does not include any md.
Could someone help me out pls?

[CLOVIS]

Did you override the module name anywhere?

What are the contents of the README.md file?

[CLOVIS]

Can you show a screenshot of the generated documentation?

[cdev]

Did you override the module name anywhere?

I haven't done anything extra other than what I wrote.

[cdev]

README.md

README.md

[cdev]

Screenshot 2024-08-22 at 14.39.03.png

[CLOVIS]

Your module isn't called kotlin-demo

[cdev]

yeah I just figured it out ..

[cdev]

it works now 😄

[CLOVIS]

The README file should start with

# Module vesper-sdk

…

since that's your module name

[cdev]

thanks!

[cdev]

one more question

[cdev]

i am not familiar with dokka, it is possible to have the packages on the left side? and just leave the md alone?

[cdev]

currently the md is there, the packages are listed below that, and the whole left section is empty

[CLOVIS]

it is possible to have the packages on the left side

Do you mean the large white margin on the left that's empty?

It's a bug in local development that makes it empty IIRC. When you deploy it for real, it looks like: https://opensavvy.gitlab.io/groundwork/prepared/api-docs/suite/index.html

Compare with the README file : https://gitlab.com/opensavvy/groundwork/prepared/-/blob/main/suite/README.md?ref_type=heads

[cdev]

nice! thank you!

[CLOVIS]

no problem 🙂

[cdev]

@CLOVIS one more, can we hide this "ANDROIDJVM" filter ?

[CLOVIS]

Have you looked at the available functions?

tasks.dokkaHtml {
    dokkaSourceSets {
        configureEach {
            this.HERE?
        }
    }
}

there's probably something like ".hide" or similar

[CLOVIS]

when asking a completely different question, it's better to send a new message to the channel, because it's likely different people will know the answer. If it's not there, I have no idea where it could be

Essentially, one question == one thread

[cdev]

got it, thank you anyway, i'll do some digging