-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Rendering documentation with scaladoc should work offline #13272
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
Comments
Looks like scaladoc tries to fetch a few js files: https://github.com/lampepfl/dotty/blob/38b983c1b4a61d4c45f314ae895b95317c322c62/scaladoc/src/dotty/tools/scaladoc/renderers/Resources.scala#L95-L99 |
Problem: The Scala 3.0.1 compiler includes bugs that are patched in the 3.0.2-RC1 release. An example of this is the broken Java APIs in JDK 11 for our `TimeLikeOps` classes because of scala/scala3#13039. Result / Solution: Using the 3.0.2-RC1 release doesn't break any tests and our projects compile fine. Let's update to this to make use of the bug fixes until the 3.0.2 is officially released. The new Dotty scaladoc requires network access due to a bug scala/scala3#13272. For now let's disable scaladoc for scala 3. JIRA Issues: CSL-11235 Differential Revision: https://phabricator.twitter.biz/D720887
3rd party libraries are not fetched during generation. They are included to HTMLs using URL to remote location. The real reason of this exception is fetching Inkuire from Github because Inkuire.js file needs to be locally in generated documentation. The solution is to have inkuire.js packed in scaladoc jar. |
We should not require inkuire.js when there is no |
I think including inkuire.js in the jar would also be fine, although indeed that's less important as long as inkuire is not enabled by default. |
Uh oh!
There was an error while loading. Please reload this page.
Compiler version 3.0.2-RC1
The scaladoc generator requires network access. This is not good for CI machines that run jobs with commands like
publishLocal
without network access. The exception originates fromrenderResources
here.Expectation
Ability to generate docs without network access
The text was updated successfully, but these errors were encountered: