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
Dokka 1.7.20+ ignores sourceLinks block on android library projects #2876
Comments
I don't think this PR is the cause as it only changed the visuals of the source links, it didn't touch the configuration. And seeing how it's working for non-android projects, I think something configuration-related was broken all of a sudden - maybe our integration with AGP, or maybe there's a bug in KGP or something - it needs to be researched. |
There's a similar report in Kotlin Community Slack by @covercash2:
|
- Parse module and package docs. We'll need to update these markdown files to follow the specs. - Parse snippets for sample code - Configure source link (currently broken, Kotlin/dokka#2876)
- Parse module and package docs. We'll need to update these markdown files to follow the specs. - Parse snippets for sample code - Configure source link (currently broken, Kotlin/dokka#2876)
- Parse module and package docs. We'll need to update these markdown files to follow the specs. - Parse snippets for sample code - Configure source link (currently broken, Kotlin/dokka#2876)
- Parse module and package docs. We'll need to update these markdown files to follow the specs. - Parse snippets for sample code - Configure source link (currently broken, Kotlin/dokka#2876)
Describe the bug
On dokka v1.7.20 and 1.8.10, the
sourceLinks
block is ignored on ANDROID library projects, but seems to work as expected on JVM libraries.Expected behaviour
The source link for methods should appear on generated docs of android library projects.
Screenshots
This screenshot shows the documentation generated by the
jvm-lib-working
branch of the attached file. Thats the expected behaviour in android-library projects.This is the actual behaviour, it does not show the [sources] link. This screenshot shows the documentation generated by the
android-lib-bug
branch of the attached file.This screenshot was taken while using dokka 1.7.10 on the
android-lib-bug
branch of the attached file. Note that a "sources" tab appears as expected for this version.To Reproduce
See dokka-bug.zip
In it there are two branches,
jvm-lib-working
andandroid-lib-bug
, so you can switch between the functional and the non-functional state.Step 1: Enter the project directory
Step 2: Switch to
android-lib-bug
branchStep 3: Run
./gradlew :lib:dokkaHtml
Step 4: Verify generated docs at
lib/build/dokka/html
Dokka configuration
Configuration of dokka used to reproduce the bug
Copy-pasted from the attached project.
Installation
Additional context
As i said, this bug only happens on dokka 1.7.20 and 1.8.10, from 1.7.10 down the
sourceLinks
block isnt ignored on android library projects.Although I have no proof, I suspect that this bug is related to this PR.
Are you willing to provide a PR?
Unfortunately for the time being I don't have enough knowledge to fix it.
The text was updated successfully, but these errors were encountered: