Adding a custom Dokka format with Dokkatoo #262
CLOVIS-AI
started this conversation in
Show and tell
Replies: 4 comments 7 replies
-
|
It's cool to see the first external implementation of DokkatooFormatPlugin! I think there a few things going wrong... The first thing that jumps out is the plugin version in // example/example-core/build.gradle.kts
plugins {
kotlin("multiplatform")
id("opensavvy.dokka.dokkatoo-mkdocs") // version "VERSION HERE"
}Even if that's fixed, there's still a weird error. Why does it say there are no Kotlin targets? What does Can you try it without the convention plugins? I wonder if they're interfering. |
Beta Was this translation helpful? Give feedback.
4 replies
-
|
Can you try renaming |
Beta Was this translation helpful? Give feedback.
-
|
Are you on a MacOS device?
In my CI, this only happens on MacOS: |
Beta Was this translation helpful? Give feedback.
-
|
Yes I am... I wonder if something in Gradle breaks with filename case-sensitivity? EDIT: I reproduced it and made an issue gradle/gradle#30100 |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for investigating! I'll follow the issue. |
Beta Was this translation helpful? Give feedback.
-
|
I'm starting to understand the design of Dokkatoo's Gradle plugin a bit better, and I have to say, I like it. I originally thought that I'd need to create a Gradle plugin to configures Dokkatoo, but now I understand that the Dokkatoo format class is a Gradle plugin itself, and it already applies everything automatically! So I can nuke my precompiled script plugin and have everything there instead. |
Beta Was this translation helpful? Give feedback.
0 replies
-
|
it works :)
|
Beta Was this translation helpful? Give feedback.
0 replies
-
|
Does the Dokkatoo plugin expose the generated files by The actual website sources are in a different Gradle project. There, i'd like to declare a dependency on all the projects that use |
Beta Was this translation helpful? Give feedback.
3 replies
-
|
I created a custom configuration for it. Now that I've done it twice or thrice, it seems really simple 😅 If you want to try it out:
There's a lot left to automate and clean up, but as a quick prototype it's pretty convincing! |
Beta Was this translation helpful? Give feedback.
-
|
Nice work! Dokkatoo should already set up the required configurations for sending/receiving modules, so you might not need your custom Configurations. In the aggregating project you can declare dependencies using So something like this: //build.gradle.kts
dependencies {
dokkatoo(project(":foo"))
}
val embedDokkaIntoMkDocs by target.tasks.registering(Sync::class) {
from(configurations.dokkatooMkdocsModuleOutputDirectoriesResolver)
into(layout.dir("docs/api"))
} |
Beta Was this translation helpful? Give feedback.
-
|
That is indeed much simpler, thanks a lot! |
Beta Was this translation helpful? Give feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hi!
I'm currently developing a Dokka format for integration into Material for MkDocs. I'm basing it on the official GFM format, since it is 95% of what I want, and there are only a few minor design changes I want to make.
At this time, my goal is to create a format that behaves exactly the same way as the GFM plugin, so I can just see what the setup is like. I therefore duplicated most of its code into my own repository.
It is structured as such:
:renderer: The Dokka plugin itself:example:example-core: An example project that imports the plugin (that I will use for testing):gradle:conventions:dokkatoo-mkdocs: A Dokkatoo-based Gradle plugin that should configure everything necessary for use of the new format along DokkatooThis discussion is just show progress / get feedback.
So far, I have created the different modules, however I'm having trouble with the Gradle dependencies. I would expect it to resolve the Dokka plugin automatically, but it doesn't at the moment:
I'll look into it in the coming days.
Beta Was this translation helpful? Give feedback.
All reactions