-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Fix publishing docs for scala3 libraries #11578
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
Fix publishing docs for scala3 libraries #11578
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also reuse scaladoc confitguration with generate...
tasks
Could you tell more details? |
Wn set options to control external configuration for scaladoc/javadoc as well as source mapping, revision, logo and more for |
bca9af4
to
110c7ef
Compare
110c7ef
to
302c450
Compare
@@ -741,7 +770,6 @@ object Build { | |||
// when compiling a project that depends on scala3-staging (see sbt-dotty/sbt-test/sbt-dotty/quoted-example-project), | |||
// but we always need it to be present on the JVM classpath at runtime. | |||
dependsOn(dottyCompiler(Bootstrapped) % "provided; compile->runtime; test->test"). | |||
settings(commonBootstrappedSettings). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess that line was redundant in context of line 739
@@ -752,7 +780,6 @@ object Build { | |||
// when compiling a project that depends on scala3-tasty-inspector (see sbt-dotty/sbt-test/sbt-dotty/tasty-inspector-example-project), | |||
// but we always need it to be present on the JVM classpath at runtime. | |||
dependsOn(dottyCompiler(Bootstrapped) % "provided; compile->runtime; test->test"). | |||
settings(commonBootstrappedSettings). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess that line was redundant in context of line 750
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that this PR breaks linking to external documentation in output of generateScala
task
c5a2f86
to
8093a91
Compare
981c403
to
09059a3
Compare
lazy val `scaladoc-js` = project.in(file("scaladoc-js")).asScaladocJs(Bootstrapped) | ||
lazy val `scaladoc-js-nonBootstrapped` = project.in(file("scaladoc-js")).asScaladocJs(NonBootstrapped) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is scaladoc-js-nonBootstrapped actually needed for anything? Otherwise you could just keep the bootstrapped version and avoid some complexity in the build.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to compile scala-js parts of scaladoc-nonBootstraped
. Its output will be used in documentation shipped to Maven Central.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I understand, we never publish non-bootstrapped projects on maven central.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
scaladoc-js
compiles into javascript code that is included in the documentation generated by scaladoc
(implementation of search etc.). In order to document e.g. scala3-library-bootstrapped
we need to use not bootstrapped scaladoc
and hence we need non bootstrapped version of scaladoc-js to add all the javascript pieced to documentation.
If there is better way to implement this I am happy to change it after RC2 is released.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order to document e.g. scala3-library-bootstrapped we need to use not bootstrapped scaladoc
Oh I see, this is tricky indeed but it might be possible to avoid a cycle if we can do things in this order: compile scala3-library-bootstrapped -> compile scaladoc-js -> use this scaladoc-js to generate the scala3-library-bootstrapped docs
, but that could be done post-RC2 indeed.
09059a3
to
28fe3e9
Compare
No description provided.