Skip to content

Doctool: no index.html in root of jar #13661

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
NthPortal opened this issue Oct 3, 2021 · 4 comments · Fixed by #13710
Closed

Doctool: no index.html in root of jar #13661

NthPortal opened this issue Oct 3, 2021 · 4 comments · Fixed by #13710
Milestone

Comments

@NthPortal
Copy link
Contributor

Compiler version

3.0.2

Expectation

I expected the jar to contain an index.html file in its root. Because it only has an index.html within the api directory, some tools that handle javadocs or scaladocs from Scala 2 are unable to handle the docs (e.g. javadoc.io).

@BarkingBad
Copy link
Contributor

The issue should be gone with 3.1.0, but I will double-check that one. Nonetheless, could you try one of the RC versions of 3.1.0 (best would be 3.1.0-RC3) with your current project, and if the issue still persists we will backport fixes. Unfortunately, we cannot fix it for 3.0.2 as it has been already released, but version 3.1.0 is around the corner and will be release in 2-3 weeks.

@NthPortal
Copy link
Contributor Author

yup, it's fixed in 3.1.0-RC3

@NthPortal
Copy link
Contributor Author

it seems like this might be a duplicate of #11412, but from a different angle?

@BarkingBad
Copy link
Contributor

BarkingBad commented Oct 7, 2021

I observed that under certain configurations you could not have top-level index.html. I am working on fixing that as well as on adding some integration tests proving that we always have index.html as the top file. Nonetheless, default configuration of scaladoc should work fine. (and 99% of other configurations)

As it comes to #11412 the main problem was that new scaladoc was putting always things under api directory, which was resulting in double nesting of api/api while compiled from the sbt. Now, the #13130 should have fixed it. The second question was about providing index.html for inner packages, which I am not sure if is the problem, because you can already enter through the top-level index and then navigate using the UI.

@BarkingBad BarkingBad linked a pull request Oct 7, 2021 that will close this issue
@Kordyjan Kordyjan added this to the 3.1.1 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants