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

doc building fails on Windows #5764

Closed
almibe opened this issue Aug 16, 2020 · 3 comments
Closed

doc building fails on Windows #5764

almibe opened this issue Aug 16, 2020 · 3 comments
Labels
area/windows Windows-specific issue Bug

Comments

@almibe
Copy link

almibe commented Aug 16, 2020

steps

Hello when I run any command that includes (Compile / doc) I get the following error on Windows:
[error] (Compile / doc) java.net.URISyntaxException: Illegal character in path at index 53: https://docs.oracle.com/en/java/javase/11/docs/api/C:\Program Files\AdoptOpenJDK\jdk-11.0.8.10-hotspot\jmods\java.base/java/lang/Class.html
I've tried this with sbt 1.3.4, 1.3.10, and 1.3.13

problem

It seems like Windows paths aren't be escaped properly to work with URIs.

expectation

Windows paths get escaped properly to work with URIs.

notes

Work around is just to add
publishArtifact in (Compile, packageDoc) := false
to your build.sbt

@almibe almibe added the Bug label Aug 16, 2020
@eed3si9n eed3si9n added the area/windows Windows-specific issue label Aug 16, 2020
@eed3si9n
Copy link
Member

@almibe Thanks for the report.

I think this is actually a bug on Scaladoc itself known as scala/bug#11839, and was fixed in scala/scala#8663. Please try Scala 2.13.3.

@almibe
Copy link
Author

almibe commented Aug 16, 2020

Cool, thanks.

@almibe
Copy link
Author

almibe commented Aug 16, 2020

Yep updating from 2.13.2 to 2.13.3 fixed it. Thanks again.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/windows Windows-specific issue Bug
Projects
None yet
Development

No branches or pull requests

2 participants