hey guys, I am having trouble to include a `README...
# dokka
c
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.
Copy code
tasks.dokkaHtml {
    dokkaSourceSets {
        configureEach {
            includes.from("../README.md")
            outputDirectory.set(file("../docs"))
        }
    }
}
where the
README.md
's first line is
Copy code
# 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?
c
Did you override the module name anywhere? What are the contents of the
README.md
file?
Can you show a screenshot of the generated documentation?
c
Did you override the module name anywhere?
I haven't done anything extra other than what I wrote.
README.md
Screenshot 2024-08-22 at 14.39.03.png
c
Your module isn't called
kotlin-demo
c
yeah I just figured it out ..
it works now 😄
👍 1
c
The README file should start with
Copy code
# Module vesper-sdk

…
since that's your module name
c
thanks!
one more question
i am not familiar with dokka, it is possible to have the packages on the left side? and just leave the md alone?
currently the md is there, the packages are listed below that, and the whole left section is empty
c
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
c
nice! thank you!
c
no problem 🙂
c
@CLOVIS one more, can we hide this "ANDROIDJVM" filter ?
c
Have you looked at the available functions?
Copy code
tasks.dokkaHtml {
    dokkaSourceSets {
        configureEach {
            this.HERE?
        }
    }
}
there's probably something like ".hide" or similar
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
c
got it, thank you anyway, i'll do some digging