spark-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davies <...@git.apache.org>
Subject [GitHub] spark pull request: [SPARK-3430] [PySpark] [Doc] generate PySpark ...
Date Fri, 05 Sep 2014 19:09:36 GMT
GitHub user davies opened a pull request:

    https://github.com/apache/spark/pull/2292

    [SPARK-3430] [PySpark] [Doc] generate PySpark API docs using Sphinx

    Using Sphinx to generate API docs for PySpark.
    
    requirement: Sphinx 
    
    ```
    $ cd docs/api/python/
    $ make html
    ```
    
    The generated API docs will be located at docs/api/python/_build/html/index.html
    
    It can co-exists with those generated by Epydoc. 
    
    This is the first working version, after merging in, then we can continue to improve it
and replace the epydoc finally.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/davies/spark sphinx

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/spark/pull/2292.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2292
    
----
commit 9081eadac04aba561142fc46750cf1d01b7713fe
Author: Davies Liu <davies.liu@gmail.com>
Date:   2014-09-05T18:37:56Z

    generate PySpark API docs using Sphinx

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

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


Mime
View raw message