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

How to flatten modules for multi-module configuration? #3912

Open
Zeliret opened this issue Nov 11, 2024 · 2 comments
Open

How to flatten modules for multi-module configuration? #3912

Zeliret opened this issue Nov 11, 2024 · 2 comments
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@Zeliret
Copy link

Zeliret commented Nov 11, 2024

Question
Hi there, I was able to successfully generate documentation for my multi-module project. The project is SDK, so basically a set of libraries with the same root package names.

Is it possible to flatten this structure and display packages instead of the modules?

So basically if I have:

Module A:
my.cool.package.a

Module B:
my.cool.package.b

Can I get instead of:

Module A
-- my.cool.package.b
---- some class... 
Module B
-- my.cool.package.b
---- some class...

this:

my.cool.package.a
-- some class... 
my.cool.package.b
-- some class...

etc...

@Zeliret Zeliret added the question A user question, can be resolved if the question is answered/resolved label Nov 11, 2024
@Zeliret Zeliret changed the title How to flatten modules for multi-module documentation? How to flatten modules for multi-module configuration? Nov 12, 2024
@whyoleg
Copy link
Collaborator

whyoleg commented Nov 14, 2024

Hey!
Overall, in current Dokka Gradle plugin we do have collector tasks for this, though the initial use-case for this was to support multi-module javadoc.
Anyway, in Dokka Gradle plugin v2 we are going to drop out-of-the-box support for collector tasks.

Is there any reason why you can't use multi-module output? Or you distributing it as a single jar/klib?

@Zeliret
Copy link
Author

Zeliret commented Nov 21, 2024

Hey! Overall, in current Dokka Gradle plugin we do have collector tasks for this, though the initial use-case for this was to support multi-module javadoc. Anyway, in Dokka Gradle plugin v2 we are going to drop out-of-the-box support for collector tasks.

Is there any reason why you can't use multi-module output? Or you distributing it as a single jar/klib?

For now we are using the default multi-module output, but I was thinking about merging it because from the perspective of the consumer there is no need in knowing what module contains the classes, most of them are transitive dependencies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question A user question, can be resolved if the question is answered/resolved
Projects
None yet
Development

No branches or pull requests

2 participants