aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorDongjoon Hyun <dongjoon@apache.org>2016-12-21 08:59:38 +0000
committerSean Owen <sowen@cloudera.com>2016-12-21 08:59:38 +0000
commitba4468bb24f2e13b98e7b66b44203c20393b8ab8 (patch)
tree9be15f5c3a7293972874c5c6579f456d5a4e78fd /docs/README.md
parent24c0c94128770be9034fb69518713d7f6aa1e041 (diff)
downloadspark-ba4468bb24f2e13b98e7b66b44203c20393b8ab8.tar.gz
spark-ba4468bb24f2e13b98e7b66b44203c20393b8ab8.tar.bz2
spark-ba4468bb24f2e13b98e7b66b44203c20393b8ab8.zip
[SPARK-18923][DOC][BUILD] Support skipping R/Python API docs
## What changes were proposed in this pull request? We can build Python API docs by `cd ./python/docs && make html for Python` and R API docs by `cd ./R && sh create-docs.sh for R` separately. However, `jekyll` fails in some environments. This PR aims to support `SKIP_PYTHONDOC` and `SKIP_RDOC` for documentation build in `docs` folder. Currently, we can use `SKIP_SCALADOC` or `SKIP_API`. The reason providing additional options is that the Spark documentation build uses a number of tools to build HTML docs and API docs in Scala, Python and R. Specifically, for Python and R, - Python API docs requires `sphinx`. - R API docs requires `R` installation and `knitr` (and more others libraries). In other words, we cannot generate Python API docs without R installation. Also, we cannot generate R API docs without Python `sphinx` installation. If Spark provides `SKIP_PYTHONDOC` and `SKIP_RDOC` like `SKIP_SCALADOC`, it would be more convenient. ## How was this patch tested? Manual. **Skipping Scala/Java/Python API Doc Build** ```bash $ cd docs $ SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 jekyll build $ ls api DESCRIPTION R ``` **Skipping Scala/Java/R API Doc Build** ```bash $ cd docs $ SKIP_SCALADOC=1 SKIP_RDOC=1 jekyll build $ ls api python ``` Author: Dongjoon Hyun <dongjoon@apache.org> Closes #16336 from dongjoon-hyun/SPARK-18923.
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index ffd3b5712b..90e10a104b 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -69,4 +69,5 @@ may take some time as it generates all of the scaladoc. The jekyll plugin also
PySpark docs using [Sphinx](http://sphinx-doc.org/).
NOTE: To skip the step of building and copying over the Scala, Python, R API docs, run `SKIP_API=1
-jekyll`.
+jekyll`. In addition, `SKIP_SCALADOC=1`, `SKIP_PYTHONDOC=1`, and `SKIP_RDOC=1` can be used to skip a single
+step of the corresponding language.