Skip to content

Commit ed14303

Browse files
committed
Add default scaladoc settings to scaladoc artifact publishing
1 parent be0844e commit ed14303

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

project/Build.scala

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,7 @@ object Build {
843843
"-sourcepath", (Compile / sourceDirectories).value.map(_.getAbsolutePath).distinct.mkString(File.pathSeparator),
844844
"-Yexplicit-nulls",
845845
),
846+
(Compile / doc / scalacOptions) ++= ScaladocConfigs.DefaultGenerationSettings.value.settings
846847
)
847848

848849
lazy val `scala3-library` = project.in(file("library")).asDottyLibrary(NonBootstrapped)
@@ -1892,8 +1893,7 @@ object ScaladocConfigs {
18921893
)
18931894
}
18941895

1895-
lazy val DefaultGenerationConfig = Def.task {
1896-
def distLocation = (dist / pack).value
1896+
lazy val DefaultGenerationSettings = Def.task {
18971897
def projectVersion = version.value
18981898
def socialLinks = SocialLinks(List(
18991899
"github::https://github.com/lampepfl/dotty",
@@ -1934,6 +1934,11 @@ object ScaladocConfigs {
19341934
)
19351935
}
19361936

1937+
lazy val DefaultGenerationConfig = Def.task {
1938+
def distLocation = (dist / pack).value
1939+
DefaultGenerationSettings.value
1940+
}
1941+
19371942
lazy val Scaladoc = Def.task {
19381943
DefaultGenerationConfig.value
19391944
.add(UseJavacp(true))

project/ScaladocGeneration.scala

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ object ScaladocGeneration {
141141
def remove[T <: Arg[_]: ClassTag]: GenerationConfig
142142
def withTargets(targets: Seq[String]): GenerationConfig
143143
def serialize: String
144+
def settings: Seq[String]
144145
}
145146

146147
object GenerationConfig {
@@ -173,6 +174,9 @@ object ScaladocGeneration {
173174
++ targets
174175
).mkString(" ")
175176

177+
override def settings: Seq[String] =
178+
args.map(_.serialize) ++ targets
179+
176180
private def argsWithout[T <: Arg[_]](
177181
implicit tag: ClassTag[T]
178182
): (Option[T], Seq[Arg[_]]) = args.foldLeft[(Option[T], Seq[Arg[_]])]((None, Seq.empty)) {

project/scripts/cmdScaladocTests

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ DOTTY_BOOTSTRAPPED_VERSION=$(eval $DOTTY_BOOTSTRAPPED_VERSION_COMMAND | tail -n
1919
SOURCE_LINKS_REPOSITORY="lampepfl/dotty"
2020
SOURCE_LINKS_VERSION="${GITHUB_SHA:-$DOTTY_BOOTSTRAPPED_VERSION}"
2121

22-
"$SBT" "scaladoc/generateTestcasesDocumentation" > "$tmp" 2>&1 || echo "generated testcases project with sbt"
22+
"$SBT" "scaladoc/generateTestcasesDocumentation" > "$tmp" || echo "generated testcases project with sbt"
2323
dist/target/pack/bin/scaladoc \
2424
-d "$OUT1" \
2525
-project "scaladoc testcases" \
@@ -41,5 +41,5 @@ dist/target/pack/bin/scaladoc \
4141
-default-template static-site-main \
4242
-author -groups -revision main -project-version "${DOTTY_BOOTSTRAPPED_VERSION}" \
4343
"-quick-links:Learn::https://docs.scala-lang.org/,Install::https://www.scala-lang.org/download/,Playground::https://scastie.scala-lang.org,Find A Library::https://index.scala-lang.org,Community::https://www.scala-lang.org/community/,Blog::https://www.scala-lang.org/blog/," \
44-
out/bootstrap/scaladoc-testcases/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/classes > "$tmp" 2>&1 || echo "generated testcases project with scripts"
44+
out/bootstrap/scaladoc-testcases/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/classes > "$tmp" || echo "generated testcases project with scripts"
4545
diff -rq "$OUT1" "scaladoc/output/testcases"

0 commit comments

Comments
 (0)