spark/docs
Matei Zaharia 2ae15353a1 Merge branch 'master' of github.com:mesos/spark 2013-02-25 15:14:16 -08:00
..
_layouts Some tweaks to docs 2013-02-25 14:23:03 -08:00
_plugins Use a single setting for disabling API doc build 2013-02-25 13:15:12 -08:00
css Change doc color scheme slightly for Spark 0.7 (to differ from 0.6) 2013-02-25 13:15:30 -08:00
img Various enhancements to the programming guide and HTML/CSS 2012-09-25 23:26:56 -07:00
js Adding docs directory containing documentation currently on the wiki 2012-09-12 13:03:43 -07:00
README.md Use a single setting for disabling API doc build 2013-02-25 13:15:12 -08:00
_config.yml Fixes link to issue tracker in documentation page "Contributing to Spark". 2013-02-19 16:58:02 -08:00
api.md Merge branch 'master' into streaming 2013-01-15 12:08:51 -08:00
bagel-programming-guide.md Some doc fixes, including showing version number in nav bar again 2012-10-13 19:05:11 -07:00
configuration.md Change spark.cleaner.delay to spark.cleaner.ttl. Updated docs. 2013-02-23 17:42:26 -08:00
contributing-to-spark.md Fixes link to issue tracker in documentation page "Contributing to Spark". 2013-02-19 16:58:02 -08:00
ec2-scripts.md Changes based on Matei's comment 2013-01-20 08:59:20 -08:00
index.md Some tweaks to docs 2013-02-25 14:23:03 -08:00
java-programming-guide.md Made StorageLevel constructor private, and added StorageLevels.create() to the Java API. Updates scala and java programming guides. 2013-01-23 01:10:26 -08:00
python-programming-guide.md Added checkpointing and fault-tolerance semantics to the programming guide. Fixed default checkpoint interval to being a multiple of slide duration. Fixed visibility of some classes and objects to clean up docs. 2013-02-18 02:12:41 -08:00
quick-start.md Merge pull request #346 from JoshRosen/python-api 2013-01-12 23:49:36 -08:00
running-on-mesos.md Doc fix 2012-11-16 20:49:02 -08:00
running-on-yarn.md Fixing YARN instructions 2012-10-09 22:39:28 -07:00
scala-programming-guide.md Allow passing sparkHome and JARs to StreamingContext constructor 2013-02-25 15:13:30 -08:00
spark-debugger.md Making the link to api scaladocs work and migrating other code snippets 2012-09-12 23:25:07 -07:00
spark-simple-tutorial.md Adding docs directory containing documentation currently on the wiki 2012-09-12 13:03:43 -07:00
spark-standalone.md Use a separate memory setting for standalone cluster daemons 2013-02-10 21:59:41 -08:00
streaming-custom-receivers.md Removing duplicate doc. 2013-02-24 16:32:44 -08:00
streaming-programming-guide.md Merge branch 'master' of github.com:mesos/spark 2013-02-25 15:14:16 -08:00
tuning.md Merge branch 'master' into bettersplits 2013-02-24 22:08:14 -06:00

README.md

Welcome to the Spark documentation!

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-project.org/documentation.html.

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.

Generating the Documentation HTML

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.

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.

To make things quite a bit prettier and make the links easier to follow, generate the html version of the documentation based on the src directory by running jekyll in the docs directory. Use the command SKIP_SCALADOC=1 jekyll to skip building and copying over the scaladoc which can be timely. To use the jekyll command, you will need to have Jekyll installed, the easiest way to do this is via a Ruby Gem, see the jekyll installation instructions. This will create a directory called _site containing index.html as well as the rest of the compiled files. Read more about Jekyll at https://github.com/mojombo/jekyll/wiki.

In addition to generating the site as html from the markdown files, jekyll can serve up the site via a webserver. To build and run a webserver use the command jekyll --server which (currently) runs the webserver on port 4000, then visit the site at http://localhost:4000.

Pygments

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.

To mark a block of code in your markdown to be syntax highlighted by jekyll during the compile phase, use the following sytax:

{% highlight scala %}
// Your scala code goes here, you can replace scala with many other
// supported languages too.
{% endhighlight %}

API Docs (Scaladoc and Epydoc)

You can build just the Spark scaladoc by running sbt/sbt doc from the SPARK_PROJECT_ROOT directory.

Similarly, you can build just the PySpark epydoc by running epydoc --config epydoc.conf from the SPARK_PROJECT_ROOT/pyspark directory.

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.

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