Demonstrate how to add unidoc project filter

typelevel · Apr 3, 2022 · 8062392 · 8062392
1 parent a7b68b6
commit 8062392
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -62,19 +62,24 @@ val Scala213 = "2.13.8"
 ThisBuild / crossScalaVersions := Seq(Scala213, "3.1.1")
 ThisBuild / scalaVersion := Scala213 // the default Scala
 
-lazy val root = tlCrossRootProject.aggregate(core, extra, tests)
+lazy val root = tlCrossRootProject.aggregate(core, heffalump, tests)
 
 lazy val core = crossProject(JVMPlatform, JSPlatform)
   .in(file("core"))
   .settings(
     name := "woozle-core",
+    description := "Core data types and typeclasses",
     libraryDependencies += "org.typelevel" %%% "cats-core" % "2.7.0"
   )
 
-lazy val extra = project
-  .in(file("extra"))
+lazy val heffalump = project
+  .in(file("heffalump"))
   .dependsOn(core.jvm)
-  .settings(name := "woozle-extra")
+  .settings(
+    name := "woozle-heffalump",
+    description := "Integration module with heffalump (JVM only)",
+    libraryDependencies += "org.100aker" %% "heffalump-core" % "0.8.21"
+  )
 
 lazy val tests = crossProject(JVMPlatform, JSPlatform)
   .in(file("tests"))

diff --git a/docs/site.md b/docs/site.md
@@ -39,7 +39,8 @@ lazy val unidocs = project
   .in(file("unidocs"))
   .enablePlugins(TypelevelUnidocPlugin) // also enables the ScalaUnidocPlugin
   .settings(
-    name := "woozle-docs"
+    name := "woozle-docs",
+    ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(core.jvm, heffalump)
   )
 ```