diff options
author | Shivaram Venkataraman <shivaram@cs.berkeley.edu> | 2015-08-03 17:00:59 -0700 |
---|---|---|
committer | Reynold Xin <rxin@databricks.com> | 2015-08-03 17:00:59 -0700 |
commit | 7abaaad5b169520fbf7299808b2bafde089a16a2 (patch) | |
tree | f6d5485accbe1501a59a3c68c224384f1bb5b82d /docs | |
parent | 13675c742a71cbdc8324701c3694775ce1dd5c62 (diff) | |
download | spark-7abaaad5b169520fbf7299808b2bafde089a16a2.tar.gz spark-7abaaad5b169520fbf7299808b2bafde089a16a2.tar.bz2 spark-7abaaad5b169520fbf7299808b2bafde089a16a2.zip |
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 <shivaram@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
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md index d7652e921f..50209896f9 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 |