http://git-wip-us.apache.org/repos/asf/spark-website/blob/52917ac4/site/docs/2.4.0/README.md ---------------------------------------------------------------------- diff --git a/site/docs/2.4.0/README.md b/site/docs/2.4.0/README.md new file mode 100644 index 0000000..fb67c4b --- /dev/null +++ b/site/docs/2.4.0/README.md @@ -0,0 +1,87 @@ +Welcome to the Spark documentation! + +This readme will walk you through navigating and building the Spark documentation, which is included +here with the Spark source code. You can also find documentation specific to release versions of +Spark at https://spark.apache.org/documentation.html. + +Read on to learn more about viewing documentation in plain text (i.e., markdown) or building the +documentation yourself. Why build it yourself? So that you have the docs that correspond to +whichever version of Spark you currently have checked out of revision control. + +## Prerequisites + +The Spark documentation build uses a number of tools to build HTML docs and API docs in Scala, Java, +Python, R and SQL. + +You need to have [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and +[Python](https://docs.python.org/2/using/unix.html#getting-and-installing-the-latest-version-of-python) +installed. Also install the following libraries: + +```sh +$ sudo gem install jekyll jekyll-redirect-from pygments.rb +$ sudo pip install Pygments +# Following is needed only for generating API docs +$ sudo pip install sphinx pypandoc mkdocs +$ sudo Rscript -e 'install.packages(c("knitr", "devtools", "rmarkdown"), repos="http://cran.stat.ucla.edu/")' +$ sudo Rscript -e 'devtools::install_version("roxygen2", version = "5.0.1", repos="http://cran.stat.ucla.edu/")' +$ sudo Rscript -e 'devtools::install_version("testthat", version = "1.0.2", repos="http://cran.stat.ucla.edu/")' +``` + +Note: If you are on a system with both Ruby 1.9 and Ruby 2.0 you may need to replace gem with gem2.0. + +Note: Other versions of roxygen2 might work in SparkR documentation generation but `RoxygenNote` field in `$SPARK_HOME/R/pkg/DESCRIPTION` is 5.0.1, which is updated if the version is mismatched. + +## Generating the Documentation HTML + +We include the Spark documentation as part of the source (as opposed to using a hosted wiki, such as +the github wiki, as the definitive documentation) to enable the documentation to evolve along with +the source code and be captured by revision control (currently git). This way the code automatically +includes the version of the documentation that is relevant regardless of which version or release +you have checked out or downloaded. + +In this directory you will find text files formatted using Markdown, with an ".md" suffix. You can +read those text files directly if you want. Start with `index.md`. + +Execute `jekyll build` from the `docs/` directory to compile the site. Compiling the site with +Jekyll will create a directory called `_site` containing `index.html` as well as the rest of the +compiled files. + +```sh +$ cd docs +$ jekyll build +``` + +You can modify the default Jekyll build as follows: + +```sh +# Skip generating API docs (which takes a while) +$ SKIP_API=1 jekyll build + +# Serve content locally on port 4000 +$ jekyll serve --watch + +# Build the site with extra features used on the live page +$ PRODUCTION=1 jekyll build +``` + +## API Docs (Scaladoc, Javadoc, Sphinx, roxygen2, MkDocs) + +You can build just the Spark scaladoc and javadoc by running `build/sbt unidoc` from the `$SPARK_HOME` directory. + +Similarly, you can build just the PySpark docs by running `make html` from the +`$SPARK_HOME/python/docs` directory. Documentation is only generated for classes that are listed as +public in `__init__.py`. The SparkR docs can be built by running `$SPARK_HOME/R/create-docs.sh`, and +the SQL docs can be built by running `$SPARK_HOME/sql/create-docs.sh` +after [building Spark](https://github.com/apache/spark#building-spark) first. + +When you run `jekyll build` in the `docs` directory, it will also copy over the scaladoc and javadoc 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 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 and javadoc using [Unidoc](https://github.com/sbt/sbt-unidoc). +The jekyll plugin also generates the PySpark docs using [Sphinx](http://sphinx-doc.org/), SparkR docs +using [roxygen2](https://cran.r-project.org/web/packages/roxygen2/index.html) and SQL docs +using [MkDocs](https://www.mkdocs.org/). + +NOTE: To skip the step of building and copying over the Scala, Java, Python, R and SQL API docs, run `SKIP_API=1 +jekyll build`. In addition, `SKIP_SCALADOC=1`, `SKIP_PYTHONDOC=1`, `SKIP_RDOC=1` and `SKIP_SQLDOC=1` can be used +to skip a single step of the corresponding language. `SKIP_SCALADOC` indicates skipping both the Scala and Java docs.
http://git-wip-us.apache.org/repos/asf/spark-website/blob/52917ac4/site/docs/2.4.0/api.html ---------------------------------------------------------------------- diff --git a/site/docs/2.4.0/api.html b/site/docs/2.4.0/api.html new file mode 100644 index 0000000..be47f12 --- /dev/null +++ b/site/docs/2.4.0/api.html @@ -0,0 +1,181 @@ + +<!DOCTYPE html> +<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]--> +<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]--> +<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]--> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + <title>Spark API Documentation - Spark 2.4.0 Documentation</title> + + + + + <link rel="stylesheet" href="css/bootstrap.min.css"> + <style> + body { + padding-top: 60px; + padding-bottom: 40px; + } + </style> + <meta name="viewport" content="width=device-width"> + <link rel="stylesheet" href="css/bootstrap-responsive.min.css"> + <link rel="stylesheet" href="css/main.css"> + + <script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script> + + <link rel="stylesheet" href="css/pygments-default.css"> + + + <!-- Google analytics script --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-32518208-2']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + + + </head> + <body> + <!--[if lt IE 7]> + <p class="chromeframe">You are using an outdated browser. <a href="https://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p> + <![endif]--> + + <!-- This code is taken from http://twitter.github.com/bootstrap/examples/hero.html --> + + <div class="navbar navbar-fixed-top" id="topbar"> + <div class="navbar-inner"> + <div class="container"> + <div class="brand"><a href="index.html"> + <img src="img/spark-logo-hd.png" style="height:50px;"/></a><span class="version">2.4.0</span> + </div> + <ul class="nav"> + <!--TODO(andyk): Add class="active" attribute to li some how.--> + <li><a href="index.html">Overview</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Programming Guides<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="quick-start.html">Quick Start</a></li> + <li><a href="rdd-programming-guide.html">RDDs, Accumulators, Broadcasts Vars</a></li> + <li><a href="sql-programming-guide.html">SQL, DataFrames, and Datasets</a></li> + <li><a href="structured-streaming-programming-guide.html">Structured Streaming</a></li> + <li><a href="streaming-programming-guide.html">Spark Streaming (DStreams)</a></li> + <li><a href="ml-guide.html">MLlib (Machine Learning)</a></li> + <li><a href="graphx-programming-guide.html">GraphX (Graph Processing)</a></li> + <li><a href="sparkr.html">SparkR (R on Spark)</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="api/scala/index.html#org.apache.spark.package">Scala</a></li> + <li><a href="api/java/index.html">Java</a></li> + <li><a href="api/python/index.html">Python</a></li> + <li><a href="api/R/index.html">R</a></li> + <li><a href="api/sql/index.html">SQL, Built-in Functions</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Deploying<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="cluster-overview.html">Overview</a></li> + <li><a href="submitting-applications.html">Submitting Applications</a></li> + <li class="divider"></li> + <li><a href="spark-standalone.html">Spark Standalone</a></li> + <li><a href="running-on-mesos.html">Mesos</a></li> + <li><a href="running-on-yarn.html">YARN</a></li> + <li><a href="running-on-kubernetes.html">Kubernetes</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="api.html" class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="configuration.html">Configuration</a></li> + <li><a href="monitoring.html">Monitoring</a></li> + <li><a href="tuning.html">Tuning Guide</a></li> + <li><a href="job-scheduling.html">Job Scheduling</a></li> + <li><a href="security.html">Security</a></li> + <li><a href="hardware-provisioning.html">Hardware Provisioning</a></li> + <li class="divider"></li> + <li><a href="building-spark.html">Building Spark</a></li> + <li><a href="https://spark.apache.org/contributing.html">Contributing to Spark</a></li> + <li><a href="https://spark.apache.org/third-party-projects.html">Third Party Projects</a></li> + </ul> + </li> + </ul> + <!--<p class="navbar-text pull-right"><span class="version-text">v2.4.0</span></p>--> + </div> + </div> + </div> + + <div class="container-wrapper"> + + + <div class="content" id="content"> + + <h1 class="title">Spark API Documentation</h1> + + + <p>Here you can read API docs for Spark and its submodules.</p> + +<ul> + <li><a href="api/scala/index.html">Spark Scala API (Scaladoc)</a></li> + <li><a href="api/java/index.html">Spark Java API (Javadoc)</a></li> + <li><a href="api/python/index.html">Spark Python API (Sphinx)</a></li> + <li><a href="api/R/index.html">Spark R API (Roxygen2)</a></li> + <li><a href="api/sql/index.html">Spark SQL, Built-in Functions (MkDocs)</a></li> +</ul> + + + </div> + + <!-- /container --> + </div> + + <script src="js/vendor/jquery-1.8.0.min.js"></script> + <script src="js/vendor/bootstrap.min.js"></script> + <script src="js/vendor/anchor.min.js"></script> + <script src="js/main.js"></script> + + <!-- MathJax Section --> + <script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + TeX: { equationNumbers: { autoNumber: "AMS" } } + }); + </script> + <script> + // Note that we load MathJax this way to work with local file (file://), HTTP and HTTPS. + // We could use "//cdn.mathjax...", but that won't support "file://". + (function(d, script) { + script = d.createElement('script'); + script.type = 'text/javascript'; + script.async = true; + script.onload = function(){ + MathJax.Hub.Config({ + tex2jax: { + inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], + displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], + processEscapes: true, + skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'] + } + }); + }; + script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + + 'cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js' + + '?config=TeX-AMS-MML_HTMLorMML'; + d.getElementsByTagName('head')[0].appendChild(script); + }(document)); + </script> + </body> +</html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/52917ac4/site/docs/2.4.0/api/DESCRIPTION ---------------------------------------------------------------------- diff --git a/site/docs/2.4.0/api/DESCRIPTION b/site/docs/2.4.0/api/DESCRIPTION new file mode 100644 index 0000000..5ce5abe --- /dev/null +++ b/site/docs/2.4.0/api/DESCRIPTION @@ -0,0 +1,63 @@ +Package: SparkR +Type: Package +Version: 2.4.0 +Title: R Frontend for Apache Spark +Description: Provides an R Frontend for Apache Spark. +Authors@R: c(person("Shivaram", "Venkataraman", role = c("aut", "cre"), + email = "shiva...@cs.berkeley.edu"), + person("Xiangrui", "Meng", role = "aut", + email = "m...@databricks.com"), + person("Felix", "Cheung", role = "aut", + email = "felixche...@apache.org"), + person(family = "The Apache Software Foundation", role = c("aut", "cph"))) +License: Apache License (== 2.0) +URL: http://www.apache.org/ http://spark.apache.org/ +BugReports: http://spark.apache.org/contributing.html +SystemRequirements: Java (== 8) +Depends: + R (>= 3.0), + methods +Suggests: + knitr, + rmarkdown, + testthat, + e1071, + survival +Collate: + 'schema.R' + 'generics.R' + 'jobj.R' + 'column.R' + 'group.R' + 'RDD.R' + 'pairRDD.R' + 'DataFrame.R' + 'SQLContext.R' + 'WindowSpec.R' + 'backend.R' + 'broadcast.R' + 'catalog.R' + 'client.R' + 'context.R' + 'deserialize.R' + 'functions.R' + 'install.R' + 'jvm.R' + 'mllib_classification.R' + 'mllib_clustering.R' + 'mllib_fpm.R' + 'mllib_recommendation.R' + 'mllib_regression.R' + 'mllib_stat.R' + 'mllib_tree.R' + 'mllib_utils.R' + 'serialize.R' + 'sparkR.R' + 'stats.R' + 'streaming.R' + 'types.R' + 'utils.R' + 'window.R' +RoxygenNote: 6.1.0 +VignetteBuilder: knitr +NeedsCompilation: no --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org