aboutsummaryrefslogtreecommitdiff
path: root/docs/api.md
diff options
context:
space:
mode:
authorAndy Konwinski <andyk@berkeley.edu>2012-09-12 23:05:47 -0700
committerAndy Konwinski <andyk@berkeley.edu>2012-09-12 23:25:07 -0700
commitca2c999e0fd97a29b20bd3990b6e57d9e0db5d0a (patch)
treef90eb6c5cd2bc2a342490d305677f90f7e936c0f /docs/api.md
parentc4db09ea76802df22f52826e228f9d15c0cf13d9 (diff)
downloadspark-ca2c999e0fd97a29b20bd3990b6e57d9e0db5d0a.tar.gz
spark-ca2c999e0fd97a29b20bd3990b6e57d9e0db5d0a.tar.bz2
spark-ca2c999e0fd97a29b20bd3990b6e57d9e0db5d0a.zip
Making the link to api scaladocs work and migrating other code snippets
to use pygments syntax highlighting.
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
new file mode 100644
index 0000000000..b0acbe34c5
--- /dev/null
+++ b/docs/api.md
@@ -0,0 +1,11 @@
+---
+layout: global
+title: Spark API documentation (Scaladoc)
+---
+
+Here you can find links to the Scaladoc generated for the Spark sbt subprojects. If the following links don't work, try running `sbt/sbt doc` from the Spark project home directory.
+
+- [Core]({{HOME_PATH}}../../core/target/scala-2.9.1/api/index.html)
+- [Examples]({{HOME_PATH}}../../examples/target/scala-2.9.1/api/index.html)
+- [Repl]({{HOME_PATH}}../../repl/target/scala-2.9.1/api/index.html)
+- [Bagel]({{HOME_PATH}}../../bagel/target/scala-2.9.1/api/index.html)