spark-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pwend...@apache.org
Subject spark git commit: add Sphinx as a dependency of building docs
Date Fri, 21 Nov 2014 03:13:44 GMT
Repository: spark
Updated Branches:
  refs/heads/branch-1.2 64b30be7e -> e445d3ce4


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>


Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/e445d3ce
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/e445d3ce
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/e445d3ce

Branch: refs/heads/branch-1.2
Commit: e445d3ce4e4fb9ee3c2feddb9734d541b61c6c01
Parents: 64b30be
Author: Davies Liu <davies@databricks.com>
Authored: Thu Nov 20 19:12:45 2014 -0800
Committer: Patrick Wendell <pwendell@gmail.com>
Committed: Thu Nov 20 19:13:33 2014 -0800

----------------------------------------------------------------------
 docs/README.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/spark/blob/e445d3ce/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index d2d58e4..1194840 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.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org


Mime
View raw message