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
autosummary - autosummary_imported_members doesn't apply to items in table #10058
Labels
Comments
Ahh, trying to set up a test case but it's more complicated than I thought - I think it's caused by me defining :members: or :exclude-members: or something... still looking. |
akdor1154
pushed a commit
to akdor1154/sphinx
that referenced
this issue
Jan 7, 2022
Pass the `autosummary_imported_members` config var into Documenter.options.imported_members, so we don't miss members from autosummary tables.
akdor1154
pushed a commit
to akdor1154/sphinx
that referenced
this issue
Jan 7, 2022
Pass the `autosummary_imported_members` config var into Documenter.options.imported_members, so we don't miss members from autosummary tables.
akdor1154
pushed a commit
to akdor1154/sphinx
that referenced
this issue
Jan 7, 2022
akdor1154
pushed a commit
to akdor1154/sphinx
that referenced
this issue
Jan 7, 2022
Pass the `autosummary_imported_members` config var into Documenter.options.imported_members, so we don't miss members from autosummary tables.
tk0miya
added a commit
that referenced
this issue
Jan 11, 2022
…misleads_autosummary Fix #10058: autosummary: Imported members are not shown
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Describe the bug
If I have
private.py
public.py
conf.py
docs.rst
Then I get a table with
some_fn
but notDocumentMe
:some_fn()
I believe this is because the ModuleDocumenter being used never gets its
imported_modules
flag set, regardless of app config. I'll raise a PR with a basic fix now to illustrate.How to Reproduce
Set up files as per above
Expected behavior
A table that looks like
some_fn()
DocumentMe
Your project
github.com/akdor1154/csql#caching-1
Screenshots
No response
OS
Linux
Python version
3.9
Sphinx version
4.3.2
Sphinx extensions
autodoc, autosummary
Extra tools
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: