Skip to content

Update dokka to 2.x and setup a multi-module versioned setup. - #556

Open
escardin wants to merge 1 commit into
cashapp:masterfrom
navsmb:lovelace/UpdateDocsPlugin
Open

Update dokka to 2.x and setup a multi-module versioned setup.#556
escardin wants to merge 1 commit into
cashapp:masterfrom
navsmb:lovelace/UpdateDocsPlugin

Conversation

@escardin

Copy link
Copy Markdown
Contributor

It's not any worse than what exists, but at least it's not complaining anymore. I think some small tweaks could get it all the way to working.

Comment thread buildSrc/build.gradle.kts Outdated
@lkerford

Copy link
Copy Markdown
Contributor

I don't see any change in the PR which would cause the test not to run. I don't think its related to this change but the test check isn't completed on this PR. It could be as simple as trying to re-triggering the github action by rebasing the PR

It's not any worse than what exists, but at least it's not complaining anymore. I think some small tweaks could get it all the way to working.
@escardin
escardin force-pushed the lovelace/UpdateDocsPlugin branch from 38b9ade to ba32800 Compare May 28, 2026 19:11
@adrw

adrw commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

Can you include the original error logs or motivation for this PR?

What is the motivation for the multi-module versioned? I'm not immediately seeing why we need the separate buildSrc build gradle with explicit version catalog setup when the version catalog seemed to be working fine before?

@escardin

escardin commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

Can you include the original error logs or motivation for this PR?

What is the motivation for the multi-module versioned? I'm not immediately seeing why we need the separate buildSrc build gradle with explicit version catalog setup when the version catalog seemed to be working fine before?

Actually, the docs website doesn't work (and doesn't truly work after this either). I wanted to get rid of the Dokka 2.x warnings, and the way I changed it is the recommended way to go about doing what we were doing according to the docs. That is, publishing versioned docs is supported in dokka, but we were doing some weird hack. Using a convention plugin is preferred over the anti-pattern of subprojects{} and allprojects{} blocks.

We also had notes that we were doing a post config to update paths because the publishing plugin was mangling things, but doing this way everything works as things were designed to. There are some extra things to do to fully fix the docs site, but this is a step in the right direction.

@escardin

Copy link
Copy Markdown
Contributor Author

This is the warning when trying to use the V1 mode of the plugin:

warning: Dokka Gradle plugin V1 is deprecated
    
    Dokka Gradle plugin V1 is deprecated, and will be removed in Dokka version 2.1.0
    Please migrate to Dokka Gradle plugin V2. This will require updating your project.
    To learn about migrating read the migration guide https://kotl.in/dokka-gradle-migration
    
    To start migrating to Dokka Gradle plugin V2 add
        org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers
    into your project's `gradle.properties` file.
    
    We would appreciate your feedback!
     - Please report any feedback or problems https://kotl.in/dokka-issues
     - Chat with the community visit #dokka in https://kotlinlang.slack.com/ (To sign up visit https://kotl.in/slack)

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.

3 participants