diff --git a/build.sbt b/build.sbt index 0cef3ff74..a4afd48ba 100644 --- a/build.sbt +++ b/build.sbt @@ -36,7 +36,7 @@ inThisBuild(List( tlSitePublishBranch := Some(mainBranch), )) -lazy val root = tlCrossRootProject.aggregate(parsley, parsleyDebug) +lazy val root = tlCrossRootProject.aggregate(parsley, parsleyDebug, unidocs) // These settings are shared between all projects. lazy val commonSettings = Seq( @@ -111,6 +111,17 @@ lazy val parsleyDebug = crossProject(JSPlatform, JVMPlatform, NativePlatform) ), ) +// this allows us to publish a unified doc for parsley and parsley-debug +lazy val unidocs = project + .in(file("unidoc")) + .enablePlugins(TypelevelUnidocPlugin) + .settings( + name := "parsley-docs", + ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(parsley.jvm, parsleyDebug.jvm), + Compile / doc / scalacOptions ++= Seq("-groups", "-doc-root-content", s"${baseDirectory.value.getParentFile.getPath}/parsley/rootdoc.md"), + ) + +// This is used for the website lazy val docs = project .in(file("site")) .dependsOn(parsley.jvm) diff --git a/parsley-debug/shared/src/main/scala/parsley/debugger/DebugTree.scala b/parsley-debug/shared/src/main/scala/parsley/debugger/DebugTree.scala index aa3937719..5bb341426 100644 --- a/parsley-debug/shared/src/main/scala/parsley/debugger/DebugTree.scala +++ b/parsley-debug/shared/src/main/scala/parsley/debugger/DebugTree.scala @@ -8,7 +8,7 @@ package parsley.debugger /** The tree representing a parser's parse tree (its parser execution path). * * Initially unpopulated, it will be populated with information regarding the parser, such as - * what it is (if it is a primitive such as [[parsley.internal.deepembedding.singletons.Pure]], + * what it is (if it is a primitive such as `parsley.internal.deepembedding.singletons.Pure`, * or a user-defined named parser if names are collected) as the parser itself runs on some input. * * Any tree node will store the input it has parsed (or attempted to parse) as well as its