aboutsummaryrefslogtreecommitdiff
path: root/pyspark/epydoc.conf
diff options
context:
space:
mode:
authorJosh Rosen <joshrosen@eecs.berkeley.edu>2012-12-27 17:55:33 -0800
committerJosh Rosen <joshrosen@eecs.berkeley.edu>2012-12-27 18:04:10 -0800
commit85b8f2c64f0fc4be5645d8736629fc082cb3587b (patch)
treedba808b3c96d0241654b4b0c99ec0786ac2339dd /pyspark/epydoc.conf
parent2d98fff0651af4d527f41ba50c01f453fa049464 (diff)
downloadspark-85b8f2c64f0fc4be5645d8736629fc082cb3587b.tar.gz
spark-85b8f2c64f0fc4be5645d8736629fc082cb3587b.tar.bz2
spark-85b8f2c64f0fc4be5645d8736629fc082cb3587b.zip
Add epydoc API documentation for PySpark.
Diffstat (limited to 'pyspark/epydoc.conf')
-rw-r--r--pyspark/epydoc.conf19
1 files changed, 19 insertions, 0 deletions
diff --git a/pyspark/epydoc.conf b/pyspark/epydoc.conf
new file mode 100644
index 0000000000..91ac984ba2
--- /dev/null
+++ b/pyspark/epydoc.conf
@@ -0,0 +1,19 @@
+[epydoc] # Epydoc section marker (required by ConfigParser)
+
+# Information about the project.
+name: PySpark
+url: http://spark-project.org
+
+# The list of modules to document. Modules can be named using
+# dotted names, module filenames, or package directory names.
+# This option may be repeated.
+modules: pyspark
+
+# Write html output to the directory "apidocs"
+output: html
+target: docs/
+
+private: no
+
+exclude: pyspark.cloudpickle pyspark.worker pyspark.join pyspark.serializers
+ pyspark.java_gateway pyspark.examples pyspark.shell