You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This readme will walk you through navigating and building the Spark documentation, which is included here with the Spark source code. You can also find documentation specific to release versions of Spark at http://spark.apache.org/documentation.html.
3
+
This readme will walk you through navigating and building the Spark documentation, which is included
4
+
here with the Spark source code. You can also find documentation specific to release versions of
5
+
Spark at http://spark.apache.org/documentation.html.
4
6
5
-
Read on to learn more about viewing documentation in plain text (i.e., markdown) or building the 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.
7
+
Read on to learn more about viewing documentation in plain text (i.e., markdown) or building the
8
+
documentation yourself. Why build it yourself? So that you have the docs that corresponds to
9
+
whichever version of Spark you currently have checked out of revision control.
6
10
7
11
## Generating the Documentation HTML
8
12
9
-
We include the Spark documentation as part of the source (as opposed to using a hosted wiki, such as the github wiki, as the definitive documentation) to enable the documentation to evolve along with the source code and be captured by revision control (currently git). This way the code automatically includes the version of the documentation that is relevant regardless of which version or release you have checked out or downloaded.
13
+
We include the Spark documentation as part of the source (as opposed to using a hosted wiki, such as
14
+
the github wiki, as the definitive documentation) to enable the documentation to evolve along with
15
+
the source code and be captured by revision control (currently git). This way the code automatically
16
+
includes the version of the documentation that is relevant regardless of which version or release
17
+
you have checked out or downloaded.
10
18
11
-
In this directory you will find textfiles formatted using Markdown, with an ".md" suffix. You can read those text files directly if you want. Start with index.md.
19
+
In this directory you will find textfiles formatted using Markdown, with an ".md" suffix. You can
20
+
read those text files directly if you want. Start with index.md.
12
21
13
-
The markdown code can be compiled to HTML using the
14
-
[Jekyll tool](http://jekyllrb.com).
22
+
The markdown code can be compiled to HTML using the [Jekyll tool](http://jekyllrb.com).
15
23
To use the `jekyll` command, you will need to have Jekyll installed.
16
24
The easiest way to do this is via a Ruby Gem, see the
If not already installed, you need to install `kramdown` with `sudo gem install kramdown`.
19
-
Execute `jekyll` from the `docs/` directory. Compiling the site with Jekyll will create a directory called
20
-
`_site` containing index.html as well as the rest of the compiled files.
27
+
Execute `jekyll` from the `docs/` directory. Compiling the site with Jekyll will create a directory
28
+
called `_site` containing index.html as well as the rest of the compiled files.
21
29
22
30
You can modify the default Jekyll build as follows:
23
31
@@ -30,9 +38,11 @@ You can modify the default Jekyll build as follows:
30
38
31
39
## Pygments
32
40
33
-
We also use pygments (http://pygments.org) for syntax highlighting in documentation markdown pages, so you will also need to install that (it requires Python) by running `sudo easy_install Pygments`.
41
+
We also use pygments (http://pygments.org) for syntax highlighting in documentation markdown pages,
42
+
so you will also need to install that (it requires Python) by running `sudo easy_install Pygments`.
34
43
35
-
To mark a block of code in your markdown to be syntax highlighted by jekyll during the compile phase, use the following sytax:
44
+
To mark a block of code in your markdown to be syntax highlighted by jekyll during the compile
45
+
phase, use the following sytax:
36
46
37
47
{% highlight scala %}
38
48
// Your scala code goes here, you can replace scala with many other
@@ -43,8 +53,15 @@ To mark a block of code in your markdown to be syntax highlighted by jekyll duri
43
53
44
54
You can build just the Spark scaladoc by running `sbt/sbt doc` from the SPARK_PROJECT_ROOT directory.
45
55
46
-
Similarly, you can build just the PySpark epydoc by running `epydoc --config epydoc.conf` from the SPARK_PROJECT_ROOT/pyspark directory. Documentation is only generated for classes that are listed as public in `__init__.py`.
56
+
Similarly, you can build just the PySpark epydoc by running `epydoc --config epydoc.conf` from the
57
+
SPARK_PROJECT_ROOT/pyspark directory. Documentation is only generated for classes that are listed as
58
+
public in `__init__.py`.
47
59
48
-
When you run `jekyll` in the `docs` directory, it will also copy over the scaladoc for the various Spark subprojects into the `docs` directory (and then also into the `_site` directory). We use a jekyll plugin to run `sbt/sbt doc` 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 using [epydoc](http://epydoc.sourceforge.net/).
60
+
When you run `jekyll` in the `docs` directory, it will also copy over the scaladoc for the various
61
+
Spark subprojects into the `docs` directory (and then also into the `_site` directory). We use a
62
+
jekyll plugin to run `sbt/sbt doc` before building the site so if you haven't run it (recently) it
63
+
may take some time as it generates all of the scaladoc. The jekyll plugin also generates the
64
+
PySpark docs using [epydoc](http://epydoc.sourceforge.net/).
49
65
50
-
NOTE: To skip the step of building and copying over the Scala and Python API docs, run `SKIP_API=1 jekyll`.
66
+
NOTE: To skip the step of building and copying over the Scala and Python API docs, run `SKIP_API=1
0 commit comments