Skip to content
Snippets Groups Projects
Commit 8cd6eea6 authored by Davies Liu's avatar Davies Liu Committed by Patrick Wendell
Browse files

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
parent 02ec058e
No related branches found
No related tags found
No related merge requests found
...@@ -43,7 +43,7 @@ You can modify the default Jekyll build as follows: ...@@ -43,7 +43,7 @@ You can modify the default Jekyll build as follows:
## Pygments ## Pygments
We also use pygments (http://pygments.org) for syntax highlighting in documentation markdown pages, 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 To mark a block of code in your markdown to be syntax highlighted by jekyll during the compile
phase, use the following sytax: phase, use the following sytax:
...@@ -53,6 +53,11 @@ phase, use the following sytax: ...@@ -53,6 +53,11 @@ phase, use the following sytax:
// supported languages too. // supported languages too.
{% endhighlight %} {% 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) ## API Docs (Scaladoc and Sphinx)
You can build just the Spark scaladoc by running `sbt/sbt doc` from the SPARK_PROJECT_ROOT directory. You can build just the Spark scaladoc by running `sbt/sbt doc` from the SPARK_PROJECT_ROOT directory.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment