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

External doc links in Dokka are broken #10

Open
EdricChan03 opened this issue Dec 20, 2022 · 0 comments
Open

External doc links in Dokka are broken #10

EdricChan03 opened this issue Dec 20, 2022 · 0 comments

Comments

@EdricChan03
Copy link

Given the following Dokka configuration:

tasks.withType<DokkaTaskPartial>().configureEach {
    dokkaSourceSets.configureEach {
        // ...

        // Ktor API docs
        externalDocumentationLink("https://api.ktor.io/")
    }
}

When the Ktor HttpClient class is referenced in my code, in the generated docs, it tries to link the API doc to https://api.ktor.io/ktor-client-core/io.ktor.client/-http-client/index.html instead of https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client/-http-client.html.

From what I can tell, this is possibly because the Ktor sources house the Ktor client in a top-level "ktor-client" folder, resulting in the latter instead of the former.

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

No branches or pull requests

1 participant