aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Koenig2021-12-01 10:43:56 -0800
committerJack Koenig2021-12-01 11:40:52 -0800
commit5a85e213ffa23e01aaee1f8d9468e7e675203d9f (patch)
tree672976ae26bb8231b00bda224cd3cb07184e5757
parent5ae1d2544514aa04240df7ed7f36442838dda9ea (diff)
Ignore firrtl.antlr package in API doc generation
The classes should not really be part of the firrtl public API to begin with and they cause issues during ScalaDoc generation.
-rw-r--r--build.sbt3
1 files changed, 3 insertions, 0 deletions
diff --git a/build.sbt b/build.sbt
index 0ff2effa..9fba6a6b 100644
--- a/build.sbt
+++ b/build.sbt
@@ -130,6 +130,9 @@ lazy val docSettings = Seq(
Compile / doc := (ScalaUnidoc / doc).value,
autoAPIMappings := true,
Compile / doc / scalacOptions ++= Seq(
+ // ANTLR-generated classes aren't really part of public API and cause
+ // errors in ScalaDoc generation
+ "-skip-packages", "firrtl.antlr",
"-Xfatal-warnings",
"-feature",
"-diagrams",