You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2017/07/14 21:49:07 UTC

arrow git commit: ARROW-1215: [Python] Generate documentation for class members in API Reference

Repository: arrow
Updated Branches:
  refs/heads/master 8cad26e3a -> cb31b8bc1


ARROW-1215: [Python] Generate documentation for class members in API Reference

Author: Philipp Moritz <pc...@gmail.com>

Closes #840 from pcmoritz/pyarrow-doc-members and squashes the following commits:

b09f9df1 [Philipp Moritz] generate documentation for class members in API Reference


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

Branch: refs/heads/master
Commit: cb31b8bc17560a5ac770c8529bfb859dffb5b98c
Parents: 8cad26e
Author: Philipp Moritz <pc...@gmail.com>
Authored: Fri Jul 14 17:49:02 2017 -0400
Committer: Wes McKinney <we...@twosigma.com>
Committed: Fri Jul 14 17:49:02 2017 -0400

----------------------------------------------------------------------
 python/doc/source/conf.py | 3 +++
 1 file changed, 3 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/arrow/blob/cb31b8bc/python/doc/source/conf.py
----------------------------------------------------------------------
diff --git a/python/doc/source/conf.py b/python/doc/source/conf.py
index 4a72fd0..c7f098f 100644
--- a/python/doc/source/conf.py
+++ b/python/doc/source/conf.py
@@ -56,6 +56,9 @@ extensions = [
     'IPython.sphinxext.ipython_console_highlighting'
 ]
 
+# Show members for classes in .. autosummary
+autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance', 'inherited-members']
+
 # numpydoc configuration
 napoleon_use_rtype = False