chore(deps): update dependency org.jetbrains.dokka to v2 #18
Conversation
Release notes previewNo new release will be created. If you are expecting a release, you will need to either fix a bug or add a feature. |
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
52d215e to
66c2aef
Compare
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
66c2aef to
cd1759d
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
cd1759d to
3cc88f9
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
3cc88f9 to
f183318
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
f183318 to
6395db8
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
6395db8 to
0091722
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
0091722 to
54a97fe
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
54a97fe to
d44461d
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
d44461d to
ed79327
Compare
Breaking changes file
|
open-turo-bot
force-pushed
the
c/renovate_major-2-dokka
branch
from
ed79327 to
0a404f4
Compare
This PR contains the following updates:
1.8.20->2.1.0Warning
Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
Kotlin/dokka (org.jetbrains.dokka)
v2.1.0: 2.1.0Dokka 2.1.0 focuses on stabilizing experimental features, supporting new Kotlin language features, and improving the user experience. Key highlights include:
More details about each of the changes below. See Dokka 2.1.0 milestone for the list of all changes.
Dokka's Gradle plugin v2 is enabled by default!
Dokka 2.0.0 introduced a significantly improved Gradle plugin v2, and with Dokka 2.1.0 it is now enabled by default!
As a result, all types and Gradle tasks related to Dokka Gradle plugin v1 are deprecated and will be removed in future releases.
Running Gradle tasks related to Dokka Gradle plugin v1 will result in an error during execution.
Starting from this release, the minimum supported Gradle version is 7.6.3.
Other fixes and improvements
modulePathfor root project to avoid clashing outputs during aggregation (#4158)Dokka's K2 analysis is enabled by default!
Dokka 2.1.0fixes the most problematic issues with K2 analysis and makes it enabled by default!
In addition to this, Dokka 2.1.0with K2 analysis introduces support for context parameters and nested typealiases!
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.
If you previously opted in to Dokka's K2 analysis, remove
org.jetbrains.dokka.experimental.tryK2from your project'sgradle.propertiesfile.Dokka's K1 analysis is still available, but it is deprecated and will be removed in future releases.
We would greatly appreciate your feedback, if there is something that is blocking you from migrating to K2 analysis!
Other fixes and improvements
overridemodifier for generic functions (#4126)HTML format refinement
Dokka 2.1.0 introduces a number of design improvements to the HTML output.
Many UI elements (listed below) now feature more consistent spacing, better contrast, and improved overall accessibility.
Highlights:
In addition, the structure of the templates has been slightly modified. If you're using custom templates, the easiest way to migrate is to update your templates based on the latest default templates.
For example, to enable the resizable Table of Contents, you need to add a
<div id="resizer">element and add[data-item-type]attributes to container elements. For implementation details, see the template reference.Updated UI Elements:
Notable improvements
packagesfield, which is used byDefaultExternalLocationProvider.resolve(#4009)DisplaySourceSetas it's stored a lot inside ofContentPages (#4008)PackageList(#4198)Other changes and bugfixes
>in code blocks (#4210)Changes from 2.1.0-Beta
Feedback
We would appreciate your feedback!
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
dokkaPublicationDirectorytobasePublicationsDirectory(#3876)dokkaModuleDirectory, and mark as internal (#3880)dokkaGenerateondokkaGenerateModule*(#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.propertiesfile:org.jetbrains.dokka.experimental.tryK2=trueKnown 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--innerandnavigation-title.versions-dropdownto make them more accessible.navigation-controls--homepageto 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
v1.9.20: 1.9.20General bugfixes
sealedkeyword in signatures (#2994)innerkeyword in Kotlin signatures (#2793)@paramtag not working with type parameters (#3199)HTML format
Runners
Gradle Plugin
Maven Plugin
dokka:helpbeing absent (#3035). Thanks to @aSemy!CLI runner
sourceRootsconfiguration option (#2571)Plugin API
Other:
wasm-jsandwasm-wasitargets introduced in Kotlin 1.9.20 are supported (#3310)See Dokka 1.9.20 milestone for the list of all changes.
v1.9.10: 1.9.10General
HTML format
Gradle
Java
v1.9.0: 1.9.0General improvements
HTML format
This release is packed with enhancements and bugfixes that make your API reference docs mobile-friendly!
You may find it a weird direction for improvement — we were just as surprised to find that almost 1/4 of Standard Library's API reference traffic is coming from mobile devices. Thanks to the Kotlin Website team, who contributed these improvements, Dokka now provides a solid experience to such visitors.
Improvements:
Bugfixes
Java interoperability
Javadoc format
@author,@sinceand@returntags (#1770). Thanks to @irina-turova!Other
Known problems
Some Multiplatform Gradle 8 projects might experience build failures when resolving native/platform dependencies. Please, see #3153 for more details and workarounds.
Breaking changes
This release introduces some breaking changes that are expected to affect only a fraction of Dokka users.
HTML
Note: this section only applies to those customizing Dokka's HTML format by overriding styles or HTML templates. If you are not doing any customizations, you may skip this section.
To lay a solid foundation to making the HTML format responsive, some page layouts and many styles had to be changed in a backward-incompatible manner.
If you are overriding
logo-styles.cssto provide your own header logo, please update it to be in line with the new styles - there is significantly less position hardcoding now. See this example for how it can be done.If you are overriding
styles.csswith your own file, please update the baseline styles to the latest, and see if anything is broken. If you get stuck with adapting your styles to the changes, the diff might help.If you are overriding
base.ftlorheader.ftltemplates, please update them to the latest, and adapt your changes.CLI runner
Due to the analysis refactoring needed for the migration to K2 (#3099), the JARs required to run Dokka have slightly changed.
The following JARs are no longer supported or published:
Please, replace them with a single JAR:
Plugin API
An internal refactoring of Dokka's analysis API was much needed for the migration to K2, leading to breaking changes in some cases.
If your Dokka plugin compiles without any problems — you may ignore this information, you are likely not affected.
If something doesn't compile or doesn't work anymore, please see #3099 for more details.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, 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.