Skip to content
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

The Dokka versioning dropdown is not visible #3597

Open
DhanshriP opened this issue May 2, 2024 · 2 comments
Open

The Dokka versioning dropdown is not visible #3597

DhanshriP opened this issue May 2, 2024 · 2 comments
Labels

Comments

@DhanshriP
Copy link

Describe the bug

When setting up Dokka for an Android project with multiple modules sometimes face an issue. While creating versioning of documentation using dokka, dokkaPlugin should be added in build.gradle file
dependencies { dokkaPlugin('org.jetbrains.dokka:versioning-plugin:1.9.20') } and setting up the classpath for dokka-gradle-plugin on project level build.gradle and apply org.jetbrains.dokka plugin.

These steps are crucial for Dokka to create accurate and versioned documentation for multi module project.

Expected behaviour
As mentioned in example of dokka multi module, If anyone add versioning-plugin in classpath at project level build.gradle and dokkaPlugin dependency in module level build.gradle it should show dokka drop down of versions like shown in below screenshot :
Screenshots
Screenshot 2024-05-02 at 10 38 23 PM

To Reproduce
Followed steps and took a reference of official dokka repository:
https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-versioning-multimodule-example

Dokka configuration

plugins {
    kotlin("jvm") version "1.9.22"
    id("org.jetbrains.dokka") version "1.9.20" apply false
}

// The versioning plugin must be applied in all submodules
subprojects {
    repositories {
        mavenCentral()
    }
    apply {
        plugin("org.jetbrains.kotlin.jvm")
        plugin("org.jetbrains.dokka")
    }
    val dokkaPlugin by configurations
    dependencies {
        dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.9.20")
    }
}

Installation

  • Operating system: macOS
  • Build tool: Gradle v8.0.2
  • Dokka version: 1.9.20
@DhanshriP DhanshriP added the bug label May 2, 2024
@vmishenev
Copy link
Member

It seems this issues is a duplicate of #3488 (comment)

@DhanshriP
Copy link
Author

DhanshriP commented May 10, 2024

It seems this issues is a duplicate of #3488 (comment)

Yes, We need to apply plugin with dokkaHtmlMultiModule dependency otherwise it will not show versioning drop-down for multi module project.

As I have observed, official dokka documentation is not updated with same information.
Here I have created a blog for how to use versioning plugin in dokka for reference purpose:

https://medium.com/@dhanshri_pathrikar/streamlined-dokka-integration-multi-module-projects-with-versioning-plugin-in-android-abf7a70b2f69

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants