-
Notifications
You must be signed in to change notification settings - Fork 409
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
Multi Module documentation, requires README.md, and includes
of file with duplicate content.
#1265
Comments
Maybe if multimodule, automatically add the documentation of the modules to the individual module view. |
@KotlinIsland AFAICS it seems possible to add the module description at the very beginning of the # Module ‹name of the module›
‹one paragraph of module description›
Then in the Gradle build script: tasks.withType(DokkaTask::class) {
dokkaSourceSets {
configureEach {
includes = listOf("README.md", "packages.md")
}
}
} But I don't particularly like this solution. In my opinion, Dokka should (as you suggested) rather pull the module description from the Then |
@KotlinIsland: Very fair point. Agree with you. |
I think #1136 should also be tackled together with this. |
Dokka Multi-Module will not require any module description files anymore! If you specified any includes in the project, those will be automatically included |
Was the README issue fixed as well? I'm using version 1.4.0 and Dokka still seems to require README files in every module. |
This will be available in 1.4.10 |
If you want to document a module within a multi module project, you have to add a README.md file to each module, but also add and
includes
amodules.md
file with the same(presumably) content for it to be included in the non-modules doc view:This seems a little redundant, messy and inconsistent.
The text was updated successfully, but these errors were encountered: