Skip to content

allow automodapi to document individual items #265

Closed

Description

@eteq

This was discussed in #219 as item 3. From @mdboom:

I want to document some classes that aren't listed in the module's __all__ but are returned from functions in that module. It's helpful to know how the class works, but instantiating the class is a private implementation detail. Having a way of listing additional module members might do the trick. They wouldn't have to be displayed in a separate list. This is a pretty low-priority concern relative to the others. In the end, I've just added the class to __all__ as a workaround for now.

This could be implemented as an option to automodapi, but the catch is that we want a way to make it apparent that the item is not a public item that is importable. It's not clear what the best way is to do this, though...

Activity

  1. ghost assigned on Jun 8, 2012
  2. bsipocz commented on Jul 17, 2017

    @bsipocz
    Member

    I think this issue should be moved upstream to sphinx-automodapi, isn't it?

  3. added
    Close?Tell stale bot that this issue/PR is stale
    on Jul 17, 2017
  4. bsipocz commented on Jul 18, 2017

    @bsipocz
    Member

    @pllim - Wow, that's great. Then I go ahead and closed this here.

  5. removed
    Close?Tell stale bot that this issue/PR is stale
    on Jul 18, 2017
  6. added a commit that references this issue on Jul 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions