-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Classes inheriting from other classes, defined in mocked modules, are ignored #4956
Comments
Thank you for reporting. I'll take a look this later. |
At present, it can't make subclasses of the class on mocked module.
@shimizukawa Do you have any idea for this? |
…ass of the class on mocked module
Thank you for confirmation! I'll merge it later (after fixing CI errors). |
…ass of the class on mocked module
Okay, I'll check it in the thread. |
…ass of the class on mocked module
Fix #4956: autodoc: Failed to extract document from a subclass of the class on mocked module
Fixed by #4995 |
Now it is possible to document PyQt5 projects on readthedocs, with simple configuration tweaks. |
As advised by @djhoese, this is a reopening of #1880.
Unfortunately, this is not #2174 (solved).
Actually, the docstrings of classes inheriting from other classes in mocked modules are ignored.
A real case is described in https://stackoverflow.com/q/50203452/3565696.
Here is a minimal working example, all files in the same directory
(also attached as sphinx-mock-bug.zip, for convenience).
Project module
foo.y
:conf.py
:contents.rst
:And finally, the
bar.py
"external" module (only used when the autodoc_mock_imports is commented out):The command used to build:
sphinx-build -b html . _build/html
To see the file where the dosctring should be visible:
firefox _build/html/foo.html
Environment info:
[and same on readthedocs for the real project]
The text was updated successfully, but these errors were encountered: