Skip to content
Snippets Groups Projects
Commit 7abaaad5 authored by Shivaram Venkataraman's avatar Shivaram Venkataraman Committed by Reynold Xin
Browse files

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
parent 13675c74
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment