Update dokka to v1.9.20 #60
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
force-pushed
the
renovate/dokka
branch
from
dc6c7f0 to
7ea8d60
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
7ea8d60 to
59bf80a
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
59bf80a to
112724e
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
112724e to
9fa583b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.8.20->1.9.201.8.20->1.9.20Release Notes
Kotlin/dokka (org.jetbrains.dokka:dokka-core)
v1.9.20: 1.9.20General bugfixes
sealedkeyword in signatures (https://github.com/Kotlin/dokka/issues/2994)innerkeyword in Kotlin signatures (https://github.com/Kotlin/dokka/issues/2793)@paramtag not working with type parameters (https://github.com/Kotlin/dokka/issues/3199)HTML format
Runners
Gradle Plugin
Maven Plugin
dokka:helpbeing absent (https://github.com/Kotlin/dokka/issues/3035). Thanks to @aSemy!CLI runner
sourceRootsconfiguration option (https://github.com/Kotlin/dokka/issues/2571)Plugin API
Other:
wasm-jsandwasm-wasitargets introduced in Kotlin 1.9.20 are supported (https://github.com/Kotlin/dokka/issues/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 (https://github.com/Kotlin/dokka/issues/1770). Thanks to @irina-turova!Other
Known problems
Some Multiplatform Gradle 8 projects might experience build failures when resolving native/platform dependencies. Please, see https://github.com/Kotlin/dokka/issues/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 these updates again.
This PR was generated by Mend Renovate. View the repository job log.