diff options
| author | Josh Rosen <joshrosen@databricks.com> | 2015-11-30 16:37:27 -0800 |
|---|---|---|
| committer | Josh Rosen <joshrosen@databricks.com> | 2015-11-30 16:37:27 -0800 |
| commit | d3ca8cfac286ae19f8bedc736877ea9d0a0a072c (patch) | |
| tree | e3cc7dcf77d673403633ab821ce0217af75d2300 /project | |
| parent | edb26e7f4e1164645971c9a139eb29ddec8acc5d (diff) | |
| download | spark-d3ca8cfac286ae19f8bedc736877ea9d0a0a072c.tar.gz spark-d3ca8cfac286ae19f8bedc736877ea9d0a0a072c.tar.bz2 spark-d3ca8cfac286ae19f8bedc736877ea9d0a0a072c.zip | |
[SPARK-12000] Fix API doc generation issues
This pull request fixes multiple issues with API doc generation.
- Modify the Jekyll plugin so that the entire doc build fails if API docs cannot be generated. This will make it easy to detect when the doc build breaks, since this will now trigger Jenkins failures.
- Change how we handle the `-target` compiler option flag in order to fix `javadoc` generation.
- Incorporate doc changes from thunterdb (in #10048).
Closes #10048.
Author: Josh Rosen <joshrosen@databricks.com>
Author: Timothy Hunter <timhunter@databricks.com>
Closes #10049 from JoshRosen/fix-doc-build.
Diffstat (limited to 'project')
| -rw-r--r-- | project/SparkBuild.scala | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/project/SparkBuild.scala b/project/SparkBuild.scala index f575f0012d..63290d8a66 100644 --- a/project/SparkBuild.scala +++ b/project/SparkBuild.scala @@ -160,7 +160,12 @@ object SparkBuild extends PomBuild { javacOptions in Compile ++= Seq( "-encoding", "UTF-8", - "-source", javacJVMVersion.value, + "-source", javacJVMVersion.value + ), + // This -target option cannot be set in the Compile configuration scope since `javadoc` doesn't + // play nicely with it; see https://github.com/sbt/sbt/issues/355#issuecomment-3817629 for + // additional discussion and explanation. + javacOptions in (Compile, compile) ++= Seq( "-target", javacJVMVersion.value ), @@ -547,9 +552,9 @@ object Unidoc { publish := {}, unidocProjectFilter in(ScalaUnidoc, unidoc) := - inAnyProject -- inProjects(OldDeps.project, repl, examples, tools, streamingFlumeSink, yarn), + inAnyProject -- inProjects(OldDeps.project, repl, examples, tools, streamingFlumeSink, yarn, testTags), unidocProjectFilter in(JavaUnidoc, unidoc) := - inAnyProject -- inProjects(OldDeps.project, repl, bagel, examples, tools, streamingFlumeSink, yarn), + inAnyProject -- inProjects(OldDeps.project, repl, bagel, examples, tools, streamingFlumeSink, yarn, testTags), // Skip actual catalyst, but include the subproject. // Catalyst is not public API and contains quasiquotes which break scaladoc. |