Skip to content

Show source from private modules #515

@pafi-code

Description

@pafi-code

Sometimes when I don't want to expose everything in a module, subpackage or whatever I go the following way:

my_package
    __init__.py
    _my_subpackage
        __init__.py
        _my_module.py

Let's say I would like to expose a class from _my_module.py. Then I would do this via exposing the class into _my_subpackage.__init__.py and then into my_package.__init__.py. So I can then use it like this: my_package.MyClass.

So what I want is to just generate api for the top level part where everything is supposed to be public. Therefore I don't use the private-members configuration.
This works in a sense that MyClass can be seen under autoapi/index.html. However I'm missing the very neat [source] button that redirects me to the source where MyClass is implemented, because obviously the file where it's implement is private and therefore nothing get's generated in the build/html/modules/ directory for it.

Is there a workaround for this by chance? 😆 (I know that this is a very specific kind of case)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions