Skip to content

Commit

Permalink
enabled unidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
j-mie6 committed Dec 28, 2024
1 parent 274edcb commit 4875485
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
13 changes: 12 additions & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4875485

Please sign in to comment.