make unidoc dependent on environ variable since compiles all projects

delta-io · Feb 13, 2025 · 267372a · 267372a
1 parent 616b956
commit 267372a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/build.sbt b/build.sbt
@@ -178,10 +178,6 @@ def crossSparkSettings(): Seq[Setting[_]] = getSparkVersion() match {
     Antlr4 / antlr4Version := "4.9.3",
     Test / javaOptions ++= Seq("-Dlog4j.configurationFile=log4j2.properties"),
 
-    // Java-/Scala-/Uni-Doc Settings
-    scalacOptions ++= Seq(
-      "-P:genjavadoc:strictVisibility=true" // hide package private types and methods in javadoc
-    ),
     unidocSourceFilePatterns := Seq(SourceFilePattern("io/delta/tables/", "io/delta/exceptions/"))
   )
 

diff --git a/project/Unidoc.scala b/project/Unidoc.scala
@@ -49,6 +49,7 @@ object Unidoc {
       generateScalaDoc: Boolean = false,
       classPathToSkip: String = null
     ): Project = {
+      if (sys.env.contains("DISABLE_UNIDOC")) return projectToUpdate
       if (!generatedJavaDoc && !generateScalaDoc) return projectToUpdate
 
       var updatedProject: Project = projectToUpdate
@@ -69,7 +70,12 @@ object Unidoc {
           generateUnidocSettings(docTitle, generateScalaDoc, classPathToSkip),
 
           // Ensure unidoc is run with tests.
-          (Test / test) := ((Test / test) dependsOn (Compile / unidoc)).value
+          (Test / test) := ((Test / test) dependsOn (Compile / unidoc)).value,
+
+          // hide package private types and methods in javadoc
+          scalacOptions ++= Seq(
+            "-P:genjavadoc:strictVisibility=true"
+          ),
         )
     }