We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Creation of mini-galleries with backreferences_dir and doc_module generates an empty rst file if you use a function in an example like this:
backreferences_dir
doc_module
import package.module package.module.my_fun()
It works if you directly import the function in the example:
from package.module import my_fun my_fun()
or if you import the function in the __init__.py file of the package (i.e.:
__init__.py
from .module import ( my_fun, )
Note that this is only for functions. Classes work fine in all cases.
Refer to sphinx-gallery/sample-project#1 (comment) for suggestion on how to fix.
The text was updated successfully, but these errors were encountered:
Successfully merging a pull request may close this issue.
Creation of mini-galleries with
backreferences_dir
anddoc_module
generates an empty rst file if you use a function in an example like this:It works if you directly import the function in the example:
or if you import the function in the
__init__.py
file of the package (i.e.:Note that this is only for functions. Classes work fine in all cases.
Refer to sphinx-gallery/sample-project#1 (comment) for suggestion on how to fix.
The text was updated successfully, but these errors were encountered: