diff options
| author | Patrick Wendell <pwendell@gmail.com> | 2014-01-06 17:29:21 -0800 |
|---|---|---|
| committer | Patrick Wendell <pwendell@gmail.com> | 2014-01-06 17:29:21 -0800 |
| commit | c0498f9265e32ba82bcf48bf0df0f29c6cfea587 (patch) | |
| tree | 55cce48bc1b7dcc4645715d06256c9923d6dd922 /docs/README.md | |
| parent | f236ddd1a245a587d5ee331fb67cf41456ed383c (diff) | |
| parent | e4d6057b6692ca5f071819b4ec6eb5240a0a16bc (diff) | |
| download | spark-c0498f9265e32ba82bcf48bf0df0f29c6cfea587.tar.gz spark-c0498f9265e32ba82bcf48bf0df0f29c6cfea587.tar.bz2 spark-c0498f9265e32ba82bcf48bf0df0f29c6cfea587.zip | |
Merge remote-tracking branch 'apache-github/master' into standalone-driver
Conflicts:
core/src/main/scala/org/apache/spark/deploy/client/AppClient.scala
core/src/main/scala/org/apache/spark/deploy/client/TestClient.scala
core/src/main/scala/org/apache/spark/deploy/master/Master.scala
core/src/main/scala/org/apache/spark/deploy/worker/Worker.scala
core/src/main/scala/org/apache/spark/scheduler/cluster/SparkDeploySchedulerBackend.scala
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md index dfcf753553..e3d6c9a5bc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -27,10 +27,10 @@ To mark a block of code in your markdown to be syntax highlighted by jekyll duri ## API Docs (Scaladoc and Epydoc) -You can build just the Spark scaladoc by running `sbt/sbt doc` from the SPARK_PROJECT_ROOT directory. +You can build just the Spark scaladoc by running `sbt doc` from the SPARK_PROJECT_ROOT directory. Similarly, you can build just the PySpark epydoc by running `epydoc --config epydoc.conf` from the SPARK_PROJECT_ROOT/pyspark directory. -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/). +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 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 Scala and Python API docs, run `SKIP_API=1 jekyll`. |