aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorDavies Liu <davies@databricks.com>2014-11-20 19:12:45 -0800
committerPatrick Wendell <pwendell@gmail.com>2014-11-20 19:13:33 -0800
commite445d3ce4e4fb9ee3c2feddb9734d541b61c6c01 (patch)
tree0c91d4a6d5fedb31b2b00683c92b1d089ee895b4 /docs/README.md
parent64b30be7e4cb86059bbfeb3e2f8f47f41d015862 (diff)
downloadspark-e445d3ce4e4fb9ee3c2feddb9734d541b61c6c01.tar.gz
spark-e445d3ce4e4fb9ee3c2feddb9734d541b61c6c01.tar.bz2
spark-e445d3ce4e4fb9ee3c2feddb9734d541b61c6c01.zip
add Sphinx as a dependency of building docs
Author: Davies Liu <davies@databricks.com> Closes #3388 from davies/doc_readme and squashes the following commits: daa1482 [Davies Liu] add Sphinx dependency (cherry picked from commit 8cd6eea6298fc8e811dece38c2875e94ff863948) Signed-off-by: Patrick Wendell <pwendell@gmail.com>
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index d2d58e435d..1194840380 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -43,7 +43,7 @@ You can modify the default Jekyll build as follows:
## 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`.
+so you will also need to install that (it requires Python) by running `sudo pip 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:
@@ -53,6 +53,11 @@ phase, use the following sytax:
// supported languages too.
{% endhighlight %}
+## Sphinx
+
+We use Sphinx to generate Python API docs, so you will need to install it by running
+`sudo pip install sphinx`.
+
## API Docs (Scaladoc and Sphinx)
You can build just the Spark scaladoc by running `sbt/sbt doc` from the SPARK_PROJECT_ROOT directory.