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

Upgrade to Dokka 1.4.20 #25573

Closed
sdeleuze opened this issue Aug 10, 2020 · 4 comments
Closed

Upgrade to Dokka 1.4.20 #25573

sdeleuze opened this issue Aug 10, 2020 · 4 comments
Assignees
Labels
type: dependency-upgrade A dependency upgrade type: documentation A documentation task
Milestone

Comments

@sdeleuze
Copy link
Contributor

See https://blog.jetbrains.com/kotlin/2020/08/dokka-preview-based-on-kotlin-1-4-0-rc/, depends on Kotlin/dokka#1293.

@sdeleuze sdeleuze added the type: documentation A documentation task label Aug 10, 2020
@sdeleuze sdeleuze added this to the 5.3 RC1 milestone Aug 10, 2020
@sdeleuze sdeleuze self-assigned this Aug 10, 2020
@jhoeller jhoeller added the type: dependency-upgrade A dependency upgrade label Aug 24, 2020
@sdeleuze
Copy link
Contributor Author

I have made progresses (see this WIP commit on a branch) but I am currently blocked by Kotlin/dokka#1466 that I raised as a question. Let's wait Dokka team answer.

@sdeleuze
Copy link
Contributor Author

Running ./gradlew dokkaHtmlMultiModule now succeeds but there are 2 blocking remaining issues:

  • A README.md is required in each modules, this requirement will be relaxed in Dokka 1.4.10 to be released shortly
  • The resulting root HTML file is empty
    image

So I move it to 5.3 RC2 to try again with Dokka 1.4.10.

@bclozel Could you please have a look to the draft commit in order to say me if you prefer a dedicated gradle/docs-subprojects.gradle file with inclusion or what I did?

@sdeleuze sdeleuze changed the title Upgrade to Dokka 1.4 Upgrade to Dokka 1.4.10 Sep 14, 2020
@sdeleuze sdeleuze modified the milestones: 5.3 RC1, 5.3 RC2 Sep 14, 2020
@sdeleuze sdeleuze modified the milestones: 5.3 RC2, 5.3 GA Sep 25, 2020
@sdeleuze sdeleuze changed the title Upgrade to Dokka 1.4.10 Upgrade to Dokka 1.4.20 Sep 25, 2020
@sdeleuze
Copy link
Contributor Author

I tried with Dokka 1.4.10 but we need more improvement on multi module handling in order to use it, see Kotlin/dokka#1302 (comment).

@sdeleuze sdeleuze added the status: blocked An issue that's blocked on an external project change label Sep 25, 2020
@sdeleuze sdeleuze modified the milestones: 5.3 GA, 5.x Backlog Oct 25, 2020
@jhoeller
Copy link
Contributor

Addressed as part of #26870.

@jhoeller jhoeller removed the status: blocked An issue that's blocked on an external project change label Nov 11, 2021
@jhoeller jhoeller modified the milestones: 6.x Backlog, 5.3.10 Nov 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: dependency-upgrade A dependency upgrade type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

2 participants