Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support processing __all__? #220

Open
zeelot opened this issue Oct 19, 2021 · 1 comment
Open

Support processing __all__? #220

zeelot opened this issue Oct 19, 2021 · 1 comment
Assignees

Comments

@zeelot
Copy link

zeelot commented Oct 19, 2021

Is your feature request related to a problem? Please describe.

I keep all of my class implementations in private modules (python files starting with _). I export a public API using the __init__.py file like this:

"""Core Engine Components"""
from ._game_object import (
    GameObject,
    GameObjectsCollection,
)

__all__ = [
    "GameObject",
    "GameObjectsCollection",
]

But it doesn't look like the generated docs followed the import properly and exposed the GameObject at the root of my package. Am I missing some options? Sorry, I'm struggling to understand exactly what's possible here!

Describe the solution you'd like

I would like my package documentation to include the classes I exposed using __all__ in __init__.py files. I tried updating the processor configs and I can get the class name to show up but it does not seem to have any of the documentation.

Describe alternatives you've considered

Not sure what alternatives I have now. I can do this with Sphinx but I really hate that Sphinx executes all of your code so this project seemed pretty great!

Additional context

Thanks for all the work!

@NiklasRosenstein
Copy link
Owner

Hey @zeelot , I'm sure that technically it is possible as long as __all__ can be evaluated using ast.literal_eval(). :) I might look into that in a bit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants