GitHub user dongjoon-hyun opened a pull request:
https://github.com/apache/spark/pull/16336
[SPARK-API-DOC][DOC][BUILD] Support skipping R/Python API docs
## What changes were proposed in this pull request?
This PR aims to support `SKIP_PYTHONDOC` and `SKIP_RDOC` for documentation
build. 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.
Especially,
- 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
```
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/dongjoon-hyun/spark SPARK-18923
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/16336.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #16336
----
commit 2aa11d831401969a1c6052ece749ec4d56beb117
Author: Dongjoon Hyun <[email protected]>
Date: 2016-12-19T05:19:48Z
[SPARK-API-DOC][DOC][BUILD] Support skipping R/Python API docs
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
