-
Notifications
You must be signed in to change notification settings - Fork 3
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
chore(deps): update dependency org.jetbrains.dokka to v2 #108
Conversation
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Branch Coverage (ubuntu-24.04)
|
Line Coverage (ubuntu-24.04)
|
Branch Coverage (windows-2022)
|
Line Coverage (windows-2022)
|
This PR contains the following updates:
1.9.20
->2.0.0
Release Notes
Kotlin/dokka (org.jetbrains.dokka)
v2.0.0
: 2.0.0Dokka 2.0.0 focuses on simplifying configuration and preparing for support of future Kotlin language features. Key highlights include:
More details about each of the changes below. See Dokka 2.0.0 milestone for the list of all changes.
Dokka's Gradle plugin v2 based on Dokkatoo
Dokka 2.0.0 introduces significant improvements to Dokka Gradle plugin, aligning more closely with Gradle best practices:
Changes from Dokka 2.0.0-Beta
dokkaPublicationDirectory
tobasePublicationsDirectory
(https://github.com/Kotlin/dokka/pull/3876)dokkaModuleDirectory
, and mark as internal (https://github.com/Kotlin/dokka/pull/3880)dokkaGenerate
ondokkaGenerateModule*
(https://github.com/Kotlin/dokka/pull/3920)Dokka's K2 analysis
Dokka 2.0.0 introduces K2 analysis, which is currently in an experimental stage. Dokka's K2 analysis leverages Kotlin's K2 compiler frontend for analysing code and uses the same shared Analysis API, which is used in IntelliJ IDEA’s K2 mode. The output with K2 analysis should mostly match that of K1 analysis, but there may be minor differences. We are actively working towards stabilizing K2 analysis and are planning to enable K2 analysis by default in future.
To opt in to Dokka's K2 analysis, add the following flag to your project's
gradle.properties
file:org.jetbrains.dokka.experimental.tryK2=true
Known limitations:
We would greatly value your feedback if you encounter any of these limitations.
Potential differences between the outputs of K1 and K2:
While the output of K2 analysis aims to align with K1, there are some differences to be aware of:
HTML format
Dokka 2.0.0 introduces some changes to HTML output. We updated the structure of some elements and classes, particularly in the navigation and sidebar, to improve accessibility and simplify maintenance. These changes only affect you if you previously customized Dokka styles.
navigation--inner
andnavigation-title
.versions-dropdown
to make them more accessible.navigation-controls--homepage
to improve consistency. For example, it’s now callednavigation-controls--btn_homepage
.For more information, see the pull request.
The easiest way to update your current templates is to adjust the new templates to your needs.
Bugfixes
Other changes
Feedback
We would appreciate your feedback!
Full Changelog: Kotlin/dokka@v1.9.20...v2.0.0
Configuration
📅 Schedule: Branch creation - "* 0-3 1 * *" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.