Skip to content

Add a prerequisites section for building docs #7912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
shivaram wants to merge 1 commit into from
Closed

Add a prerequisites section for building docs #7912

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

@srowen srowen Aug 4, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mostly redundant with existing docs below though ... ? delete one of them

Copy link
Contributor Author

@shivaram shivaram Aug 4, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rxin can probably add more, but I meant this to be redundant in the sense this section had a bunch of commands you could copy-paste while the succeeding sections had the rationale / breakdown of what was required when.

Copy link
Member

@srowen srowen Aug 4, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK no problem. It's hardly a big deal; was more worrying about later updating one bit but not the other but, it's an ancillary doc that's not frequently updated.

Copy link
Contributor

@rxin rxin Aug 4, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will reword README in a bit to make it more consistent.

$ 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
Expand Down