Skip to content

[SPARK-13300][Documentation] Added pygments.rb dependancy #11180

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
wants to merge 2 commits into from
Closed

[SPARK-13300][Documentation] Added pygments.rb dependancy #11180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f705e9b
Added pygments.rb dependancy
amitdev Feb 12, 2016
044b0d8
[Documentation] Added more details about setup
amitdev Feb 14, 2016
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
21 changes: 13 additions & 8 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,18 @@ 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,
Python and R. To get started you can run the following commands
Python and R.

$ sudo gem install jekyll
$ sudo gem install jekyll-redirect-from
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
$ 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 All @@ -38,14 +41,16 @@ compiled files.
$ 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, Sphinx, roxygen2)

Expand All @@ -59,7 +64,7 @@ When you run `jekyll` in the `docs` directory, it will also copy over the scalad
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. The jekyll plugin also generates the
PySpark docs [Sphinx](http://sphinx-doc.org/).
PySpark docs using [Sphinx](http://sphinx-doc.org/).

NOTE: To skip the step of building and copying over the Scala, Python, R API docs, run `SKIP_API=1
jekyll`.