Merge pull request #6003 from jorisvandenbossche/numpydoc

DOC: update numpydoc to current master (commit 223df02530)

Author: jorisvandenbossche

doc/sphinxext/MANIFEST.in

@@ -1,8 +1,6 @@
 -------------------------------------------------------------------------------
     The files
     - numpydoc.py
-    - autosummary.py
-    - autosummary_generate.py
     - docscrape.py
     - docscrape_sphinx.py
     - phantom_import.py
@@ -71,10 +69,9 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 -------------------------------------------------------------------------------
-    The files
-    - only_directives.py
+    The file
     - plot_directive.py
-    originate from Matplotlib (http://matplotlib.sf.net/) which has
+    originates from Matplotlib (http://matplotlib.sf.net/) which has
     the following license:
 
 Copyright (c) 2002-2008 John D. Hunter; All Rights Reserved.

doc/sphinxext/__init__.py

@@ -14,17 +14,10 @@ The following extensions are available:
 
   - ``numpydoc.traitsdoc``: For gathering documentation about Traits attributes.
 
-  - ``numpydoc.plot_directives``: Adaptation of Matplotlib's ``plot::``
+  - ``numpydoc.plot_directive``: Adaptation of Matplotlib's ``plot::``
     directive. Note that this implementation may still undergo severe
     changes or eventually be deprecated.
 
-  - ``numpydoc.only_directives``: (DEPRECATED)
-
-  - ``numpydoc.autosummary``: (DEPRECATED) An ``autosummary::`` directive.
-    Available in Sphinx 0.6.2 and (to-be) 1.0 as ``sphinx.ext.autosummary``,
-    and it the Sphinx 1.0 version is recommended over that included in
-    Numpydoc.
-
 
 numpydoc
 ========
@@ -47,6 +40,12 @@ The following options can be set in conf.py:
   Whether to show all members of a class in the Methods and Attributes
   sections automatically.
 
+- numpydoc_class_members_toctree: bool
+
+  Whether to create a Sphinx table of contents for the lists of class
+  methods and attributes. If a table of contents is made, Sphinx expects
+  each entry to have a separate page.
+
 - numpydoc_edit_link: bool  (DEPRECATED -- edit your HTML template instead)
 
   Whether to insert an edit link after docstrings.

doc/sphinxext/LICENSE.txt doc/sphinxext/numpydoc/LICENSE.txtdoc/sphinxext/LICENSE.txt renamed to doc/sphinxext/numpydoc/LICENSE.txt

@@ -0,0 +1,3 @@
+from __future__ import division, absolute_import, print_function
+
+from .numpydoc import setup

doc/sphinxext/README.txt doc/sphinxext/numpydoc/README.rstdoc/sphinxext/README.txt renamed to doc/sphinxext/numpydoc/README.rst

@@ -1,25 +1,29 @@
-from cStringIO import StringIO
+from __future__ import division, absolute_import, print_function
+
+import sys
+if sys.version_info[0] >= 3:
+    from io import StringIO
+else:
+    from io import StringIO
+
 import compiler
 import inspect
 import textwrap
 import tokenize
 
-from compiler_unparse import unparse
+from .compiler_unparse import unparse
 
 
 class Comment(object):
-
     """ A comment block.
     """
     is_comment = True
-
     def __init__(self, start_lineno, end_lineno, text):
         # int : The first line number in the block. 1-indexed.
         self.start_lineno = start_lineno
         # int : The last line number. Inclusive!
         self.end_lineno = end_lineno
-        # str : The text block including '#' character but not any leading
-        # spaces.
+        # str : The text block including '#' character but not any leading spaces.
         self.text = text
 
     def add(self, string, start, end, line):
@@ -31,15 +35,13 @@ def add(self, string, start, end, line):
 
     def __repr__(self):
         return '%s(%r, %r, %r)' % (self.__class__.__name__, self.start_lineno,
-                                   self.end_lineno, self.text)
+            self.end_lineno, self.text)
 
 
 class NonComment(object):
-
     """ A non-comment block of code.
     """
     is_comment = False
-
     def __init__(self, start_lineno, end_lineno):
         self.start_lineno = start_lineno
         self.end_lineno = end_lineno
@@ -54,14 +56,12 @@ def add(self, string, start, end, line):
 
     def __repr__(self):
         return '%s(%r, %r)' % (self.__class__.__name__, self.start_lineno,
-                               self.end_lineno)
+            self.end_lineno)
 
 
 class CommentBlocker(object):
-
     """ Pull out contiguous comment blocks.
     """
-
     def __init__(self):
         # Start with a dummy.
         self.current_block = NonComment(0, 0)
@@ -75,7 +75,11 @@ def __init__(self):
     def process_file(self, file):
         """ Process a file object.
         """
-        for token in tokenize.generate_tokens(file.next):
+        if sys.version_info[0] >= 3:
+            nxt = file.__next__
+        else:
+            nxt = file.next
+        for token in tokenize.generate_tokens(nxt):
             self.process_token(*token)
         self.make_index()
 
@@ -160,6 +164,6 @@ def get_class_traits(klass):
         if isinstance(node, compiler.ast.Assign):
             name = node.nodes[0].name
             rhs = unparse(node.expr).strip()
-            doc = strip_comment_marker(
-                cb.search_for_comment(node.lineno, default=''))
+            doc = strip_comment_marker(cb.search_for_comment(node.lineno, default=''))
             yield name, rhs, doc
+