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

Merge multiproject (composite build) docs #1864

Closed
DanielRibeiroMaciel-TomTom opened this issue Apr 20, 2021 · 7 comments
Closed

Merge multiproject (composite build) docs #1864

DanielRibeiroMaciel-TomTom opened this issue Apr 20, 2021 · 7 comments
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@DanielRibeiroMaciel-TomTom
Copy link

DanielRibeiroMaciel-TomTom commented Apr 20, 2021

How do I merge multiproject docs? Is that currently possible? We're using 1.4.30.
If not, is there a workaround? In older versions of dokka it was possible to add external files to the classpath, but It is not clear to me how I could do that in the newer dokka rewrite. Especially if I still want the modules from the composite project to appear as modules in the merged dokka documentation?

It would already help if it was possible to just add the sources of the secondary project to the dokka classpath of the parent project.

@DanielRibeiroMaciel-TomTom DanielRibeiroMaciel-TomTom added the question A user question, can be resolved if the question is answered/resolved label Apr 20, 2021
@kamildoleglo
Copy link
Contributor

Yes, it's supported by default, please see http://kotlin.github.io/dokka/1.5/user_guide/gradle/usage/#multi-module-projects

@kamildoleglo
Copy link
Contributor

As for composite builds - as long as you add output of the DokkaPartial tasks from those composite builds to the root DokkaMultiModule task via childDokkaTasks it shouldn't be a problem (we've not tested that one yet though)

@DanielRibeiroMaciel-TomTom
Copy link
Author

@kamildoleglo note I am asking about multiproject and not multimodule. I am already using dokkaHtmlMultiModule task.
But we also have composite builds (multiple projects, each containing multiple modules).

@DanielRibeiroMaciel-TomTom
Copy link
Author

I will try the childDokkaTasks solution, thanks.

@kamildoleglo
Copy link
Contributor

kamildoleglo commented May 4, 2021

Sure, but AFAIK you can use the tasks from composite builds like ordinary ones (at least their output and that's what we're after). Worst-case scenario is that you'll have to create a wrapper tasks in the project for the tasks from the composite builds, but I don't think this will be necessary

@IgnatBeresnev
Copy link
Member

I'll close the question as resolved, hopefully you were able to figure it out.

In case anyone else has the same question or it's still relevant, please consult Dokka's documentation, it might have answers

@shyr
Copy link

shyr commented Sep 22, 2023

@DanielRibeiroMaciel-TomTom Hi, Daniel. Did you succeed in merging mult project documents? I am struggling with the same issue.

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

4 participants