Skip to content

automodule rename #10199

@tdegeus

Description

@tdegeus

I have a set of functions written in C++ that I compile in a module _foo.
My python module simply imports all functions from it. I.e. foo/__init__.py reads

from _foo import *

To document these functions I have to do .. automodule:: foo._foo, or specifically:

.. automodule:: foo._foo
    :members:
    :special-members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: __weakref__, __doc__, __module__, __dict__, __members__, __getstate__, __setstate__

which results in a bit ugly and misleading documentation that seems to suggest that the user has to use functions like foo._foo.myfunc. How can I change the documentation such that instead it shows what the user can do, i.e. foo.myfunc?

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:enhancementenhance or introduce a new feature

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions