Skip to content

Missing package-list files in documentation #290

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

Closed
as-com opened this issue Mar 16, 2018 · 4 comments
Closed

Missing package-list files in documentation #290

as-com opened this issue Mar 16, 2018 · 4 comments
Assignees
Labels

Comments

@as-com
Copy link

as-com commented Mar 16, 2018

For example, if I configure Dokka with this:

	externalDocumentationLink {
		url = new URL("https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/")
	}

... it complains about a missing package-list:

  1) Error injecting constructor, java.lang.RuntimeException: Exception while loading package-list from ExternalDocumentationLinkImpl(url=https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/, packageListUrl=https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/package-list)
    at org.jetbrains.dokka.ExternalDocumentationLinkResolver.<init>(ExternalDocumentationLinkResolver.kt:27)
    at org.jetbrains.dokka.ExternalDocumentationLinkResolver.class(ExternalDocumentationLinkResolver.kt:27)
    while locating org.jetbrains.dokka.ExternalDocumentationLinkResolver
      for parameter 4 at org.jetbrains.dokka.DeclarationLinkResolver.<init>(DeclarationLinkResolver.kt:13)
    while locating org.jetbrains.dokka.DeclarationLinkResolver
      for parameter 0 at org.jetbrains.dokka.PackageDocs.<init>(PackageDocs.kt:13)
    at org.jetbrains.dokka.PackageDocs.class(PackageDocs.kt:12)
    while locating org.jetbrains.dokka.PackageDocs
  
  1 error
@elizarov elizarov added the bug label Mar 16, 2018
@elizarov
Copy link
Contributor

Thanks. Good catch. We need to fix build script for the site module to copy the package lists files to the jekyll output folder.

@elizarov elizarov self-assigned this May 16, 2018
atoulme added a commit to atoulme/kotlinx.coroutines that referenced this issue May 29, 2018
@snicoll
Copy link

snicoll commented Jul 14, 2021

@elizarov this is still 404ing for us.

@qwwdfsad
Copy link
Collaborator

At some point, Java migrated from per-module package-lists to multimodule package-list: https://docs.oracle.com/en/java/javase/12/docs/api/element-list

Dokka (=> kotlinx.coroutines as well) did the same and now we only provide a multimodule list: https://kotlin.github.io/kotlinx.coroutines/package-list

We're discussing whether we should provide an additional per-module package-lists right now

@qwwdfsad
Copy link
Collaborator

We decided to keep it as is for a while

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

4 participants