autosummary document imported functions

[shimizukawa]

Hello,

I'm looking for a way to exclude imported modules and functions.

The attached examples list isfile in functions of my module.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/1061
• Originally reported by: Anonymous
• Originally created at: 2012-12-18T16:59:40.487

[shimizukawa]

From Takayuki Shimizukawa on 2013-01-20 02:12:50+00:00

I can not reproduce autodocing for imported modules and functions.

Please let me know about your 'autodoc' relative directive using in rst file.

[shimizukawa]

From Tiago Coutinho on 2013-10-10 09:15:55+00:00

Hello,
I am using sphinx 1.1.3 to document my python project. I can confirm the bug.

I was preparing a bug report when I saw this one. I post my original report with the hope that it can help solve the bug:

I am using autosummary with autosummary_generate = True in the conf.py

The autosummary is generating documentation for functions/classes which are imported from another module.
Example:

#!python

# --- module1.py ----
def foo():
    """foo documentation"""
    pass

# --- module2.py ---
from module1 import foo
def bar():
    """bar documentation"""
    foo()

and the following RST:

#!rst

.. doc.rst

Documentation
============

.. autosummary::
   :toctree:

   module2

will generate a RST like:

#!rst

module2
=======

.. automodule:: module2

   .. rubric:: Functions

   .. autosummary::

      foo
      bar

Please don't hesitate to ask for more info if needed.
Thanks,
Tiago

[shimizukawa]

From samuele_c on 2014-03-05 00:02:35+00:00

I'm having the exact same issue in Debian stable and Debian testing. Calling

.. autosummary:: 
   :toctree: _autosummary

includes functions imported from other modules in the summary table

[shimizukawa]

From mzjn on 2014-08-23 17:44:07+00:00

A patch has been suggested at Stack Overflow: http://stackoverflow.com/a/25460763

[shimizukawa]

From Takayuki Shimizukawa on 2014-08-29 01:53:58+00:00

We need a :imported: True option for autosummary (I think False is better for default).

It's a new feature and a incompatible change.

[shimizukawa]

From Takayuki Shimizukawa on 2014-12-19 03:41:29+00:00

Issue #1654 was marked as a duplicate of this issue.

[shimizukawa]

From Luc Saffre on 2014-12-19 04:10:55+00:00

Yes, they are the same issues.