I'm building documentation using Sphinx, and it seems that numpydoc is
raising
a lot of warnings. Specifically, the warnings look like "failed to import
<method_name>", "toctree
references unknown document u'<method_name>'", "toctree contains reference
to nonexisting document '<method_name>'---for each method defined. The
example below reproduces the issue on my system (Sphinx 1.0.7, numpy HEAD).
These warnings appear in my build of the numpy docs, as well.
Removing numpydoc from the list of Sphinx extensions gets rid of these
warnings
(but, of course, adds new warnings if headings for 'Parameters', 'Returns',
etc. are present).
Am I doing something wrong here?
Thanks,
-Tony
test_sphinx/foo.py:
===================
class Bar(object):
"""Bar docstring"""
def baz(self):
"""baz docstring"""
pass
test_sphinx/doc/source/foo.rst:
===============================
.. autoclass:: foo.Bar
:members:
Warnings from build:
====================
/Users/Tony/Desktop/test_sphinx/doc/source/foo.rst:13: (WARNING/2) failed to
import baz
/Users/Tony/Desktop/test_sphinx/doc/source/foo.rst:13: (WARNING/2) toctree
references unknown document u'baz'
/Users/Tony/Desktop/test_sphinx/doc/source/foo.rst:: WARNING: toctree
contains reference to nonexisting document 'baz'
_______________________________________________
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion
