diff options
| author | CodingCat <zhunansjtu@gmail.com> | 2015-03-30 11:41:43 +0100 |
|---|---|---|
| committer | Sean Owen <sowen@cloudera.com> | 2015-03-30 11:41:43 +0100 |
| commit | de6733036e060e18b0d1f21f9365bda81132a1a2 (patch) | |
| tree | 707a2b373f9bbc0c485bb981f0229c4ca76e7014 /docs | |
| parent | 17b13c53ec9d8579a7fb801ab781bce43809db6a (diff) | |
| download | spark-de6733036e060e18b0d1f21f9365bda81132a1a2.tar.gz spark-de6733036e060e18b0d1f21f9365bda81132a1a2.tar.bz2 spark-de6733036e060e18b0d1f21f9365bda81132a1a2.zip | |
[SPARK-6596] fix the instruction on building scaladoc
In README.md under docs/ directory, it says that
> You can build just the Spark scaladoc by running build/sbt doc from the SPARK_PROJECT_ROOT directory.
I guess the right approach is build/sbt unidoc
Author: CodingCat <zhunansjtu@gmail.com>
Closes #5253 from CodingCat/SPARK-6596 and squashes the following commits:
af379ed [CodingCat] fix the instruction on building scaladoc
Diffstat (limited to 'docs')
| -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 8a54724c4b..3773ea25c8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -60,7 +60,7 @@ We use Sphinx to generate Python API docs, so you will need to install it by run ## API Docs (Scaladoc and Sphinx) -You can build just the Spark scaladoc by running `build/sbt doc` from the SPARK_PROJECT_ROOT directory. +You can build just the Spark scaladoc by running `build/sbt unidoc` from the SPARK_PROJECT_ROOT directory. Similarly, you can build just the PySpark docs by running `make html` from the SPARK_PROJECT_ROOT/python/docs directory. Documentation is only generated for classes that are listed as @@ -68,7 +68,7 @@ public in `__init__.py`. 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 `build/sbt doc` before building the site so if you haven't run it (recently) it +jekyll plugin to run `build/sbt unidoc` 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 [Sphinx](http://sphinx-doc.org/). |