Document more then stdlib for Scala 3 doc

Author: romanowski

.github/workflows/ci.yaml

@@ -2,7 +2,15 @@ name: Dotty CI
 
 on:
   push:
+    paths-ignore:
+      # Do not run everything on changes only in docs
+      - 'scala3doc/**' 
+      - 'scala3doc-test/**'
   pull_request:
+    paths-ignore:
+      # Do not run everything on changes only in docs
+      - 'scala3doc/**' 
+      - 'scala3doc-test/**'
   schedule:
     - cron: '0 3 * * *'  # Every day at 3 AM
 

.github/workflows/scala3doc.yaml

@@ -41,5 +41,5 @@ jobs:
       - name: Generate test documentation
         run: sbt scala3doc/generateSelfDocumentation
 
-      - name: Generate documentation with SBT plugin
-        run: sbt scala3doc-example-project/doc
+      - name: Generate Scala 3 documentation
+        run: sbt scala3doc/generateScala3Documentation

project/Build.scala

@@ -136,6 +136,8 @@ object Build {
 
   val fetchScalaJSSource = taskKey[File]("Fetch the sources of Scala.js")
 
+  val aritfactsForScala3Documentation = taskKey[Seq[File]]("All artifacts to document")
+
   lazy val SourceDeps = config("sourcedeps")
 
   // Settings shared by the build (scoped in ThisBuild). Used in build.sbt
@@ -1457,7 +1459,15 @@ object Build {
       project.
         settings(commonScala3DocSettings).
         dependsOn(`scala3-compiler-bootstrapped`).
-        dependsOn(`scala3-tasty-inspector`)
+        dependsOn(`scala3-tasty-inspector`).
+        settings(aritfactsForScala3Documentation := Seq(
+            // All projects below will be put co generated documentaiton for Scala 3
+            classDirectory.in(`scala3-interfaces`).in(Compile).value,
+            classDirectory.in(`tasty-core`).in(Compile).value,
+            classDirectory.in(`scala3-library`).in(Compile).value,
+            // TODO this one fails to load using TASTY
+            // classDirectory.in(`stdlib-bootstrapped`).in(Compile).value,
+        ))
 
     def asScala3docTest: Project = 
       project.

scala3doc/.gitignore

@@ -1,40 +1,4 @@
-*.class
-*.log
-libs/
-
-# sbt specific
-.cache
-.history
-.lib/
-dist/*
-target/
-lib_managed/
-src_managed/
-project/boot/
-project/plugins/project/
-
-# Scala-IDE specific
-.scala_dependencies
-.worksheet
-.bsp
-
-# Intellij
-.idea
-
-#integration tests dir
-/test-ws
-
-# to test deploy
-private-*
-repo
-
-.metals
-metals.sbt
-.bloop
-.dotty-ide*
-
-# custom things
+# root where we generate documentation
 output
 
-.vscode
 

scala3doc/build.sbt

@@ -7,7 +7,6 @@ val dokkaSiteVersion = "0.1.9"
 libraryDependencies ++= Seq(
   "org.scala-lang" %% "scala3-tasty-inspector" % scalaVersion.value,
 
-
   "com.virtuslab.dokka" % "dokka-site" % dokkaSiteVersion,
   "org.scala-sbt" % "io_2.13" % "1.3.4",
   "com.vladsch.flexmark" % "flexmark-all" % flexmarkVersion,
@@ -17,10 +16,14 @@ libraryDependencies ++= Seq(
 ) //a a
 
 val generateSelfDocumentation = inputKey[Unit]("Generate example documentation")
-generateSelfDocumentation := {
-  run.in(Compile).fullInput(" -o output/self -t target/scala-0.27/classes -d documentation -n scala3doc -s src/main/scala=https://github.com/lampepfl/scala3doc/tree/master/src/main/scala#L").evaluated // TODO #35 proper sbt integration
-}
+generateSelfDocumentation := Def.inputTaskDyn {
+  runSelfDocumentation(classDirectory.in(Compile).value.getAbsolutePath)
+}.evaluated
 
+def runSelfDocumentation(classDir: String) = Def.taskDyn {
+    val mapping = "src/main/scala=https://github.com/lampepfl/scala3doc/tree/master/src/main/scala#L"
+    run.in(Compile).toTask(s" -o output/self -t $classDir -d documentation -n scala3doc -s $mapping")
+}
 
 // Uncomment to debug dokka processing (require to run debug in listen mode on 5005 port)
 // javaOptions.in(run) += "-agentlib:jdwp=transport=dt_socket,server=n,address=localhost:5005,suspend=y"
@@ -29,19 +32,23 @@ fork.in(run) := true
 Compile / mainClass := Some("dotty.dokka.Main")
 
 
-// TODO #35 proper sbt integration
-val generateDottyLibDocumentation = taskKey[Unit]("Generate documentation for dotty lib")
-generateDottyLibDocumentation :=  Def.taskDyn {
-  val dotttyLib = fullClasspath.in(Compile).value.find{ a =>
-    val info = a.get(moduleID.key)
-    info.nonEmpty &&
-     info.get.organization == "ch.epfl.lamp" &&
-     info.get.name.startsWith("dotty-library")
-  }
-  if (dotttyLib.isEmpty) Def.task {
+
+def generateDottyDocsFromClasspath(artifacts: Seq[String]) =  Def.taskDyn {
+  val roots = artifacts.mkString(java.io.File.pathSeparator)
+  val mapping = "=https://github.com/lampepfl/dotty/tree/master#L"
+  if (artifacts.isEmpty) Def.task {
     streams.value.log.error("Dotty lib wasn't found")
   } else Def.task {
-    run.in(Compile).toTask(s" -o output/stdLib -t ${dotttyLib.get.data} -d dotty-docs/docs -n dotty-lib -s library/src=https://github.com/lampepfl/dotty/tree/master/library/src#L").value
+    run.in(Compile).toTask(s" -o output/stdLib -t $roots -d dotty-docs/docs -n dotty-lib -s $mapping ").value
   } 
+}
+
+val generateScala3Documentation = taskKey[Unit]("Generate documentation for dotty lib")
+generateScala3Documentation := Def.taskDyn { 
+  val dotttyJars = Build.aritfactsForScala3Documentation.value.map(_.toString)
+
+  streams.value.log.info(s"Documenting classes from:\n${dotttyJars.mkString("\n")}")
+
+  generateDottyDocsFromClasspath(dotttyJars) 
 }.value