Skip to content

Commit ec40c5a

Browse files
amitdevsrowen
authored andcommitted
[SPARK-13300][DOCUMENTATION] Added pygments.rb dependancy
Looks like pygments.rb gem is also required for jekyll build to work. At least on Ubuntu/RHEL I could not do build without this dependency. So added this to steps. Author: Amit Dev <[email protected]> Closes #11180 from amitdev/master. (cherry picked from commit 331293c) Signed-off-by: Sean Owen <[email protected]>
1 parent 107290c commit ec40c5a

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

docs/README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,18 @@ whichever version of Spark you currently have checked out of revision control.
1010

1111
## Prerequisites
1212
The Spark documentation build uses a number of tools to build HTML docs and API docs in Scala,
13-
Python and R. To get started you can run the following commands
13+
Python and R.
1414

15-
$ sudo gem install jekyll
16-
$ sudo gem install jekyll-redirect-from
15+
You need to have [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and
16+
[Python](https://docs.python.org/2/using/unix.html#getting-and-installing-the-latest-version-of-python)
17+
installed. Also install the following libraries:
18+
```sh
19+
$ sudo gem install jekyll jekyll-redirect-from pygments.rb
1720
$ sudo pip install Pygments
21+
# Following is needed only for generating API docs
1822
$ sudo pip install sphinx
1923
$ Rscript -e 'install.packages(c("knitr", "devtools"), repos="http://cran.stat.ucla.edu/")'
20-
21-
24+
```
2225
## Generating the Documentation HTML
2326

2427
We include the Spark documentation as part of the source (as opposed to using a hosted wiki, such as
@@ -38,14 +41,16 @@ compiled files.
3841
$ jekyll build
3942

4043
You can modify the default Jekyll build as follows:
41-
44+
```sh
4245
# Skip generating API docs (which takes a while)
4346
$ SKIP_API=1 jekyll build
47+
4448
# Serve content locally on port 4000
4549
$ jekyll serve --watch
50+
4651
# Build the site with extra features used on the live page
4752
$ PRODUCTION=1 jekyll build
48-
53+
```
4954

5055
## API Docs (Scaladoc, Sphinx, roxygen2)
5156

@@ -59,7 +64,7 @@ When you run `jekyll` in the `docs` directory, it will also copy over the scalad
5964
Spark subprojects into the `docs` directory (and then also into the `_site` directory). We use a
6065
jekyll plugin to run `build/sbt unidoc` before building the site so if you haven't run it (recently) it
6166
may take some time as it generates all of the scaladoc. The jekyll plugin also generates the
62-
PySpark docs [Sphinx](http://sphinx-doc.org/).
67+
PySpark docs using [Sphinx](http://sphinx-doc.org/).
6368

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

0 commit comments

Comments
 (0)