pull changes from numpy doc

ddale · ddale · commit 1bb797ffb892 · 2009-04-02T08:52:52.000-04:00
diff --git a/doc/sphinxext/autosummary.py b/doc/sphinxext/autosummary.py
@@ -61,6 +61,12 @@
 
 from docscrape_sphinx import get_doc_object
 
+import warnings
+warnings.warn("The numpydoc.autosummary extension will be eventually moved to "
+              "sphinx.ext.autosummary. One version is already available in "
+              "Sphinx >= 0.6; expect this module to be deprecated after all "
+              "remaining features have been integrated there.",
+              FutureWarning, stacklevel=2)
 
 def setup(app):
     app.add_directive('autosummary', autosummary_directive, True, (0, 0, False),
@@ -161,6 +167,7 @@ def autosummary_directive(dirname, arguments, options, content, lineno,
         tocnode['includefiles'] = docnames
         tocnode['maxdepth'] = -1
         tocnode['glob'] = None
+        tocnode['entries'] = [(None, docname) for docname in docnames]
 
         tocnode = autosummary_toc('', '', tocnode)
         return warnings + [node] + [tocnode]
diff --git a/doc/sphinxext/plot_directive.py b/doc/sphinxext/plot_directive.py
@@ -74,6 +74,13 @@
 
 import sys, os, glob, shutil, imp, warnings, cStringIO, re, textwrap
 
+import warnings
+warnings.warn("A plot_directive module is also available under "
+              "matplotlib.sphinxext; expect this numpydoc.plot_directive "
+              "module to be deprecated after relevant features have been "
+              "integrated there.",
+              FutureWarning, stacklevel=2)
+
 def setup(app):
     setup.app = app
     setup.config = app.config
