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

Migration to Gradle 8.11 and Dokka 2.0 #281

Merged
merged 6 commits into from
Dec 20, 2024
Merged

Migration to Gradle 8.11 and Dokka 2.0 #281

merged 6 commits into from
Dec 20, 2024

Conversation

philips77
Copy link
Member

@philips77 philips77 commented Dec 17, 2024

This PR fixes all warnings, deprecations and migrates Dokka to V2 using https://kotlinlang.org/docs/dokka-migration.html

It may be required for some time for projects to add a flag in gradle.properties:

org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled

See: https://kotlinlang.org/docs/dokka-migration.html#set-the-opt-in-flag

Nordic Dokka Plugin

This PR also creates a new plugin: no.nordicsemi.plugin.dokka which applies Nordic look & feel to the generated documentation. This has to be added to the main build.gradle.kts file using:

plugins {
    // [...]

    alias(libs.plugins.nordic.dokka) apply true
}

@philips77
Copy link
Member Author

The Nordic style does not get applied to javadoc files in binaries distributed on Maven, just do /docs folder, which is populated to GitHub Pages.

@philips77 philips77 merged commit 5c82aa8 into main Dec 20, 2024
1 check passed
@philips77 philips77 deleted the migration branch December 20, 2024 14:33
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.

1 participant