docs: Upgrade to Dokka 2.0.0-Beta #3054
Merged
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
sargunv
commented
Nov 28, 2024
louwers
reviewed
Nov 28, 2024
louwers
approved these changes
Nov 28, 2024
There was a problem hiding this comment.
Created to tracking issues to set up documentation sites for the other two projects.
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.
Updates Dokka documentation generator to version 2.0.0-Beta and adjusts related configuration. I've found v2 to be much more stable than v1, even though it's marked as "beta". More info here: https://kotlinlang.org/docs/dokka-migration.html
sourceLink, which'll generate deep links to source code in the docs (currently not functioning possibly due to Dokka 1.7.20+ ignores sourceLinks block on android library projects Kotlin/dokka#2876, even though it works in my repo 🤷 )If https://github.com/maplibre/maplibre-java and https://github.com/maplibre/maplibre-gestures-android have dokka or javadocs set up, we can link out to those too wherever they're a part of this project's public API (similar to how dokka links out to Android docs by default for Android types). Left TODOs for them as I didn't see any dokka/javadoc sites for them.
Extra: updates .gitignore to include MapLibrePlugin build directory as this seems to have been missed in a previous commit.