Fixed documentation for Gradle multiplatform projects #2614
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you have this structure:
```
root/
module1/
module1.md
build.gradle.kts
build.gradle.kts
```
Problem:
- add the configuration for `includes.from("module1.md")` in `module1/build.gradle.kts`,
- run `./gradlew dokkaHtmlMultiModule`
- the markdown file is not included, in fact the whole configuration block is ignored
This is because `dokkaHtmlMultiModule` executes `module1:dokkaHtmlPartial`, but no `module1:dokkaHtml`.
By switching the task type, the documentation is properly taken into account.
|
Glad I could help 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you have this structure:
Problem:
includes.from("module1.md")inmodule1/build.gradle.kts,./gradlew dokkaHtmlMultiModuleThis is because
dokkaHtmlMultiModuleexecutesmodule1:dokkaHtmlPartial, but nomodule1:dokkaHtml.By switching the task type, the documentation is properly taken into account.