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

Can't get imported-members to work. #2128

Closed
amueller opened this issue Nov 23, 2015 · 4 comments
Closed

Can't get imported-members to work. #2128

amueller opened this issue Nov 23, 2015 · 4 comments

Comments

@amueller
Copy link

Following the discussion at #1892 I tried to make the scikit-learn docs build using the imported-members flag.

I tried autodoc_default_flags = ['members', 'inherited-members', 'imported-members'] but that didn't include any additional classes. I also just did autodoc_default_flags = ['imported-members'] with the same result. (version 1.3.1)

Did I misunderstand anything? Were there changes to this in master?
And is there a timeline for a release?

@veox
Copy link

veox commented Mar 27, 2017

:imported-members: works for me when the package's __init__.py imports classes from sub-modules; the classes are meant as an interface to the module's provided functionality. E.g.:

# krakenex/krakenex/__init__.py
from .api import API
from .connection import Connection
__all__ = ['API', 'Connection']

# krakenex/doc/source/index.rst
.. automodule:: krakenex
   :members:
   :imported-members:

@amueller As I understand, you want to document sub-modules in scikit-learn's __all__, correct?.. JIC, I haven't found a way to do it (yet).

@amueller
Copy link
Author

I think what I wanted to do is possible in 1.3.2. I'm not sure how it related to that flag.

@veox
Copy link

veox commented Mar 28, 2017

Is the issue OK to close then ? ;)

@amueller
Copy link
Author

Let's close as I don't have time to investigate now and the original problem is solved. We can always reopen.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants