9f24a17c59
## What changes were proposed in this pull request? When we build the docs separately we don't have the JAR files from the Spark build in the same tree. As the SparkR vignettes need to launch a SparkContext to be built, we skip building them if JAR files don't exist ## How was this patch tested? To test this we can run the following: ``` build/mvn -DskipTests -Psparkr clean ./R/create-docs.sh ``` You should see a line `Skipping R vignettes as Spark JARs not found` at the end Author: Shivaram Venkataraman <shivaram@cs.berkeley.edu> Closes #15200 from shivaram/sparkr-vignette-skip.
73 lines
2.4 KiB
Bash
Executable file
73 lines
2.4 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright ownership.
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
# (the "License"); you may not use this file except in compliance with
|
|
# the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
# Script to create API docs and vignettes for SparkR
|
|
# This requires `devtools`, `knitr` and `rmarkdown` to be installed on the machine.
|
|
|
|
# After running this script the html docs can be found in
|
|
# $SPARK_HOME/R/pkg/html
|
|
# The vignettes can be found in
|
|
# $SPARK_HOME/R/pkg/vignettes/sparkr_vignettes.html
|
|
|
|
set -o pipefail
|
|
set -e
|
|
|
|
# Figure out where the script is
|
|
export FWDIR="$(cd "`dirname "$0"`"; pwd)"
|
|
export SPARK_HOME="$(cd "`dirname "$0"`"/..; pwd)"
|
|
|
|
# Required for setting SPARK_SCALA_VERSION
|
|
. "${SPARK_HOME}"/bin/load-spark-env.sh
|
|
|
|
echo "Using Scala $SPARK_SCALA_VERSION"
|
|
|
|
pushd $FWDIR
|
|
|
|
# Install the package (this will also generate the Rd files)
|
|
./install-dev.sh
|
|
|
|
# Now create HTML files
|
|
|
|
# knit_rd puts html in current working directory
|
|
mkdir -p pkg/html
|
|
pushd pkg/html
|
|
|
|
Rscript -e 'libDir <- "../../lib"; library(SparkR, lib.loc=libDir); library(knitr); knit_rd("SparkR", links = tools::findHTMLlinks(paste(libDir, "SparkR", sep="/")))'
|
|
|
|
popd
|
|
|
|
# Find Spark jars.
|
|
if [ -f "${SPARK_HOME}/RELEASE" ]; then
|
|
SPARK_JARS_DIR="${SPARK_HOME}/jars"
|
|
else
|
|
SPARK_JARS_DIR="${SPARK_HOME}/assembly/target/scala-$SPARK_SCALA_VERSION/jars"
|
|
fi
|
|
|
|
# Only create vignettes if Spark JARs exist
|
|
if [ -d "$SPARK_JARS_DIR" ]; then
|
|
# render creates SparkR vignettes
|
|
Rscript -e 'library(rmarkdown); paths <- .libPaths(); .libPaths(c("lib", paths)); Sys.setenv(SPARK_HOME=tools::file_path_as_absolute("..")); render("pkg/vignettes/sparkr-vignettes.Rmd"); .libPaths(paths)'
|
|
|
|
find pkg/vignettes/. -not -name '.' -not -name '*.Rmd' -not -name '*.md' -not -name '*.pdf' -not -name '*.html' -delete
|
|
else
|
|
echo "Skipping R vignettes as Spark JARs not found in $SPARK_HOME"
|
|
fi
|
|
|
|
popd
|