-
Notifications
You must be signed in to change notification settings - Fork 418
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 GP v2 excludes the local module if submodules are added as dependencies #3979
Labels
bug
runner: gradle plugin v2
Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131
Comments
DanySK
added a commit
to AlchemistSimulator/Alchemist
that referenced
this issue
Dec 29, 2024
DanySK
added a commit
to AlchemistSimulator/Alchemist
that referenced
this issue
Dec 30, 2024
* feat: enable Dokka v2 * build: enable the kotest runner on multiplatform projects * build: enforce consistency in the KMP subprojects * ci: fix new task name * ci: make sure to fail on broken links * docs: link the home page * ci: fix broken retry mechanism * docs: fix links to KDoc * docs: limit docs generation to subprojects until Kotlin/dokka#3979 is fixed * docs: include both multi-module and overall documentation * docs: only check the multimodule website * docs: fix typo * docs: revise replacements
DanySK
pushed a commit
to AlchemistSimulator/Alchemist
that referenced
this issue
Dec 30, 2024
## [36.1.0](36.0.13...36.1.0) (2024-12-30) ### Features * enable Dokka v2 ([#4056](#4056)) ([c8e3565](c8e3565)), closes [Kotlin/dokka#3979](Kotlin/dokka#3979) ### Dependency updates * **deps:** update plugin java-qa to v1.81.0 ([#4054](#4054)) ([49bda56](49bda56)) * **deps:** update plugin java-qa to v1.82.0 ([#4055](#4055)) ([fe63220](fe63220)) ### Build and continuous integration * move the CI concurrency management to the dispatcher workflow ([#4058](#4058)) ([353e5dc](353e5dc)) * pin the version of ubuntu in the dispatcher workflow ([#4057](#4057)) ([b1daac5](b1daac5))
vmishenev
added
the
runner: gradle plugin v2
Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131
label
Jan 9, 2025
AngeloFilaseta
pushed a commit
to AngeloFilaseta/Alchemist
that referenced
this issue
Jan 17, 2025
* feat: enable Dokka v2 * build: enable the kotest runner on multiplatform projects * build: enforce consistency in the KMP subprojects * ci: fix new task name * ci: make sure to fail on broken links * docs: link the home page * ci: fix broken retry mechanism * docs: fix links to KDoc * docs: limit docs generation to subprojects until Kotlin/dokka#3979 is fixed * docs: include both multi-module and overall documentation * docs: only check the multimodule website * docs: fix typo * docs: revise replacements
AngeloFilaseta
pushed a commit
to AngeloFilaseta/Alchemist
that referenced
this issue
Jan 17, 2025
## [36.1.0](AlchemistSimulator/Alchemist@36.0.13...36.1.0) (2024-12-30) ### Features * enable Dokka v2 ([AlchemistSimulator#4056](AlchemistSimulator#4056)) ([c8e3565](AlchemistSimulator@c8e3565)), closes [Kotlin/dokka#3979](Kotlin/dokka#3979) ### Dependency updates * **deps:** update plugin java-qa to v1.81.0 ([AlchemistSimulator#4054](AlchemistSimulator#4054)) ([49bda56](AlchemistSimulator@49bda56)) * **deps:** update plugin java-qa to v1.82.0 ([AlchemistSimulator#4055](AlchemistSimulator#4055)) ([fe63220](AlchemistSimulator@fe63220)) ### Build and continuous integration * move the CI concurrency management to the dispatcher workflow ([AlchemistSimulator#4058](AlchemistSimulator#4058)) ([353e5dc](AlchemistSimulator@353e5dc)) * pin the version of ubuntu in the dispatcher workflow ([AlchemistSimulator#4057](AlchemistSimulator#4057)) ([b1daac5](AlchemistSimulator@b1daac5))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
bug
runner: gradle plugin v2
Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131
Describe the bug
I have a project with many subproject. The root project hosts the entrypoint of the entire application.
When generating documentation for the root project, if no subproject is added through
dependency
, only the local module's documentation is produced (as expected).When, instead,
is used, the documentation for all modules but the current is produced.
If
is used instead, the local module is included, but the left menu has broken links
Expected behaviour
Either the local module is always included, or it can be included in the dependencies without breaking the website
Screenshots
This is the documentation generated with
Links on the right work correctly, links in the left bar are broken.
To Reproduce
dokkaGenerate
Dokka configuration
The following is my convention plugin for dokka. Looks complicated , but all the complexity is just linking source from GitHub and linking libraries from javadoc.io.
Installation
The text was updated successfully, but these errors were encountered: