Skip to content

using numpydoc resulting in autosummary import error. #80

Closed
@sirno

Description

@sirno

When not explicitly declaring a method section in the class docstring numpydoc will create a autosummary table containing all public methods as an entry.
Also when only the methods names are contained in the section, i.e. method instead of method() numpydoc will also create an autosummary:

.. autosummary::

    method1
    method2
    <...>

This behaviour would be amazing, but it doesn't work unfortunately because autosummary will be unable to import the methods and thus create a table not containing any descriptions.
This may be an issue with autosummary, either on sphinx side or because the table is not generated properly. It may also be that the way I documented things is unintended. Anyways, here is a small example producing exactly the issue I am having. I'd be glad about any advice, thanks.

Minimal example:
example.zip

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions