Repository: spark Updated Branches: refs/heads/branch-1.5 864d5de6d -> b6e8446a4
Add a prerequisites section for building docs This puts all the install commands that need to be run in one section instead of being spread over many paragraphs cc rxin Author: Shivaram Venkataraman <shiva...@cs.berkeley.edu> Closes #7912 from shivaram/docs-setup-readme and squashes the following commits: cf7a204 [Shivaram Venkataraman] Add a prerequisites section for building docs (cherry picked from commit 7abaaad5b169520fbf7299808b2bafde089a16a2) Signed-off-by: Reynold Xin <r...@databricks.com> Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/141f034b Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/141f034b Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/141f034b Branch: refs/heads/branch-1.5 Commit: 141f034b4575b101c4f23d4dd5b2a95e14a632ef Parents: 864d5de Author: Shivaram Venkataraman <shiva...@cs.berkeley.edu> Authored: Mon Aug 3 17:00:59 2015 -0700 Committer: Reynold Xin <r...@databricks.com> Committed: Tue Aug 4 23:22:02 2015 -0700 ---------------------------------------------------------------------- docs/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/141f034b/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index d7652e9..5020989 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,6 +8,16 @@ Read on to learn more about viewing documentation in plain text (i.e., markdown) documentation yourself. Why build it yourself? So that you have the docs that corresponds to whichever version of Spark you currently have checked out of revision control. +## Prerequisites +The Spark documenation build uses a number of tools to build HTML docs and API docs in Scala, Python +and R. To get started you can run the following commands + + $ sudo gem install jekyll + $ sudo gem install jekyll-redirect-from + $ sudo pip install Pygments + $ Rscript -e 'install.packages(c("knitr", "devtools"), repos="http://cran.stat.ucla.edu/";)' + + ## Generating the Documentation HTML We include the Spark documentation as part of the source (as opposed to using a hosted wiki, such as --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org
