-
- Downloads
[SPARK-3430] [PySpark] [Doc] generate PySpark API docs using Sphinx
Using Sphinx to generate API docs for PySpark. requirement: Sphinx ``` $ cd python/docs/ $ make html ``` The generated API docs will be located at python/docs/_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. Author: Davies Liu <davies.liu@gmail.com> Closes #2292 from davies/sphinx and squashes the following commits: 425a3b1 [Davies Liu] cleanup 1573298 [Davies Liu] move docs to python/docs/ 5fe3903 [Davies Liu] Merge branch 'master' into sphinx 9468ab0 [Davies Liu] fix makefile b408f38 [Davies Liu] address all comments e2ccb1b [Davies Liu] update name and version 9081ead [Davies Liu] generate PySpark API docs using Sphinx
Showing
- python/docs/Makefile 179 additions, 0 deletionspython/docs/Makefile
- python/docs/conf.py 332 additions, 0 deletionspython/docs/conf.py
- python/docs/epytext.py 27 additions, 0 deletionspython/docs/epytext.py
- python/docs/index.rst 37 additions, 0 deletionspython/docs/index.rst
- python/docs/make.bat 242 additions, 0 deletionspython/docs/make.bat
- python/docs/modules.rst 7 additions, 0 deletionspython/docs/modules.rst
- python/docs/pyspark.mllib.rst 77 additions, 0 deletionspython/docs/pyspark.mllib.rst
- python/docs/pyspark.rst 18 additions, 0 deletionspython/docs/pyspark.rst
- python/docs/pyspark.sql.rst 10 additions, 0 deletionspython/docs/pyspark.sql.rst
- python/pyspark/broadcast.py 3 additions, 0 deletionspython/pyspark/broadcast.py
- python/pyspark/context.py 1 addition, 1 deletionpython/pyspark/context.py
- python/pyspark/serializers.py 3 additions, 0 deletionspython/pyspark/serializers.py
- python/pyspark/sql.py 8 additions, 4 deletionspython/pyspark/sql.py
Loading
Please register or sign in to comment