Hello,

I have a question about documenting module functions with the
autosummary directive.

The python module i want to document looks like this

****************** test.py ************************

A test module
=============

The test functions
--------------------------

.. currentmodule:: test2

.. autosummary::

   test_function
   Test.do

***************** eof *******************

I wrote a rst file to produce a list with the functions/methods
contained in this file.

********************* test.rst ************************

A test module
=============

The test functions
------------------

.. currentmodule:: test

.. autosummary::

   test_function
   Test.do

********************** eof ************************

When I try to build this with sphinx 1.0.7 I get the following warning

(WARNING/2) failed to import object test.test_function

and no doc string is extracted for test_function. In contrast, there
are no problems for the Test.do method which inside a class.

How do get sphinx to extract also doc strings for module functions
that are not class members?

Thanks in advance

Daniel

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to