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

Configure Dokka tasks for project & modules #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rowan-mcalpin
Copy link
Contributor

No description provided.

@zachwaffle4 zachwaffle4 self-requested a review December 2, 2024 00:36
Copy link
Collaborator

@zachwaffle4 zachwaffle4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was already a gradle task dokkaHtmlMultiModule; is the extra scripting necessary? (genuine question)

@rowan-mcalpin
Copy link
Contributor Author

There was already a gradle task dokkaHtmlMultiModule; is the extra scripting necessary? (genuine question)

What file was the dokkaHtmlMultiModule task in? I don't see it anywhere...

Further, yes, the DokkaPartial tasks within each module are necessary, as they allow the packages and modules to receive names (see attached). Reference: https://github.com/Kotlin/dokka/blob/cea2574021b720728bb79d9388480aa7c54f0dc1/examples/gradle/dokka-multimodule-example/parentProject/childProjectA/build.gradle.kts#L12-L20

image

@zachwaffle4
Copy link
Collaborator

The task is part of the dokka plugin. THank you for the DokkaPartial tasks tho (they are also part of the dokka plugin but not with that level of control).

@rowan-mcalpin
Copy link
Contributor Author

rowan-mcalpin commented Dec 2, 2024

The task is part of the dokka plugin.

The dokka plugin does not configure the task (such as modifying the copyright slug or specifying output dir)

To clarify, the further scripts are not creating new tasks. They are configuring the already-existing ones created by the dokka plugin

@rowan-mcalpin rowan-mcalpin changed the title Dokka configuration for multi-module project Configure Dokka tasks for project & modules Dec 2, 2024
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