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 /docs/_plugins/copy_api_dirs.rb | |
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 'docs/_plugins/copy_api_dirs.rb')
-rw-r--r-- | docs/_plugins/copy_api_dirs.rb | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/_plugins/copy_api_dirs.rb b/docs/_plugins/copy_api_dirs.rb index 01718d98df..f2f3e2e653 100644 --- a/docs/_plugins/copy_api_dirs.rb +++ b/docs/_plugins/copy_api_dirs.rb @@ -27,7 +27,7 @@ if not (ENV['SKIP_API'] == '1') cd("..") puts "Running 'build/sbt -Pkinesis-asl clean compile unidoc' from " + pwd + "; this may take a few minutes..." - puts `build/sbt -Pkinesis-asl clean compile unidoc` + system("build/sbt -Pkinesis-asl clean compile unidoc") || raise("Unidoc generation failed") puts "Moving back into docs dir." cd("docs") @@ -117,7 +117,7 @@ if not (ENV['SKIP_API'] == '1') puts "Moving to python/docs directory and building sphinx." cd("../python/docs") - puts `make html` + system(make html) || raise("Python doc generation failed") puts "Moving back into home dir." cd("../../") @@ -131,7 +131,7 @@ if not (ENV['SKIP_API'] == '1') # Build SparkR API docs puts "Moving to R directory and building roxygen docs." cd("R") - puts `./create-docs.sh` + system("./create-docs.sh") || raise("R doc generation failed") puts "Moving back into home dir." cd("../") |