diff options
| author | Matei Zaharia <matei@eecs.berkeley.edu> | 2013-02-25 13:15:12 -0800 |
|---|---|---|
| committer | Matei Zaharia <matei@eecs.berkeley.edu> | 2013-02-25 13:15:12 -0800 |
| commit | 3c7dcb61ab335ea19107354f091249ca8ca9d930 (patch) | |
| tree | 40b9c680810222e07df6e6a76f442836095ee6ba /docs | |
| parent | 0cb8ee93cd602f852078df8c8eee934daede02c4 (diff) | |
| download | spark-3c7dcb61ab335ea19107354f091249ca8ca9d930.tar.gz spark-3c7dcb61ab335ea19107354f091249ca8ca9d930.tar.bz2 spark-3c7dcb61ab335ea19107354f091249ca8ca9d930.zip | |
Use a single setting for disabling API doc build
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 2 | ||||
| -rw-r--r-- | docs/_plugins/copy_api_dirs.rb | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/docs/README.md b/docs/README.md index 887f407f18..c2b3497bb3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -33,4 +33,4 @@ Similarly, you can build just the PySpark epydoc by running `epydoc --config epy When you run `jekyll` in the docs directory, it will also copy over the scaladoc for the various Spark subprojects into the docs directory (and then also into the _site directory). We use a jekyll plugin to run `sbt/sbt doc` before building the site so if you haven't run it (recently) it may take some time as it generates all of the scaladoc. The jekyll plugin also generates the PySpark docs using [epydoc](http://epydoc.sourceforge.net/). -NOTE: To skip the step of building and copying over the scaladoc when you build the docs, run `SKIP_SCALADOC=1 jekyll`. Similarly, `SKIP_EPYDOC=1 jekyll` will skip PySpark API doc generation. +NOTE: To skip the step of building and copying over the Scala and Python API docs, run `SKIP_API=1 jekyll`. diff --git a/docs/_plugins/copy_api_dirs.rb b/docs/_plugins/copy_api_dirs.rb index e400dec619..d77e53963c 100644 --- a/docs/_plugins/copy_api_dirs.rb +++ b/docs/_plugins/copy_api_dirs.rb @@ -1,7 +1,8 @@ require 'fileutils' include FileUtils -if ENV['SKIP_SCALADOC'] != '1' +if ENV['SKIP_API'] != '1' + # Build Scaladoc for Java/Scala projects = ["core", "examples", "repl", "bagel", "streaming"] puts "Moving to project root and building scaladoc." @@ -27,9 +28,8 @@ if ENV['SKIP_SCALADOC'] != '1' puts "cp -r " + source + "/. " + dest cp_r(source + "/.", dest) end -end -if ENV['SKIP_EPYDOC'] != '1' + # Build Epydoc for Python puts "Moving to python directory and building epydoc." cd("../python") puts `epydoc --config epydoc.conf` |