Skip to content
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

Fixed documentation for Gradle multiplatform projects #2614

Closed
wants to merge 1 commit into from

Conversation

CLOVIS-AI
Copy link
Contributor

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.

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.
@IgnatBeresnev
Copy link
Member

We've revised Dokka's main documentation (#2728) and documentation for examples (#2736), and tried to address this confusion there.

I'll close this PR since the changed file will be removed soon, but thanks for bringing this to our attention! You helped us clarify it in the new documentation

@CLOVIS-AI
Copy link
Contributor Author

Glad I could help 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants