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
Imported classes within module cause WARNING: xxx specified for inheritance diagram is not a class or module #208
Labels
Comments
Having a look at the code, the directive isn't looking for imported classes, only strict definitions: sphinx-autoapi/autoapi/inheritance_diagrams.py Lines 39 to 47 in efe815c
We should be able to get it to follow imports as well. |
Perfect! Thank you :) |
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this issue
Aug 24, 2020
v1.4.0 (2020-06-07) ------------------- Features ^^^^^^^^ * `#197 <https://github.com/readthedocs/sphinx-autoapi/issues/197>`: Added ``autoapi.__version__`` and ``autoapi.__version_info__`` attributes for accessing version information. * `#201 <https://github.com/readthedocs/sphinx-autoapi/issues/201>`: (Python) Added the ``autoapi_member_order`` option to allow the order that members are documentated to be configurable. * `#203 <https://github.com/readthedocs/sphinx-autoapi/issues/203>`: (Python) A class without a docstring inherits one from its parent. A methods without a docstring inherits one from the method that it overrides. * `#204 <https://github.com/readthedocs/sphinx-autoapi/issues/204>`: (Python) Added the ``imported-members`` AutoAPI option to be able to enable or disable documenting objects imported from the same top-level package or module without needing to override templates. Bug Fixes ^^^^^^^^^ * `#198 <https://github.com/readthedocs/sphinx-autoapi/issues/198>`: Documentation describes the required layout for template override directories. * `#195 <https://github.com/readthedocs/sphinx-autoapi/issues/195>`: (Python) Fixed incorrect formatting when ``show-inheritance-diagram`` and ``private-members`` are turned on. * `#193 <https://github.com/readthedocs/sphinx-autoapi/issues/193>` and * `#208 <https://github.com/readthedocs/sphinx-autoapi/issues/208>`: (Python) Inheritance diagrams can follow imports to find classes to document. * `#213 <https://github.com/readthedocs/sphinx-autoapi/issues/213>`: (Python) Fixed module summary never showing. Trivial/Internal Changes ^^^^^^^^^^^^^^^^^^^^^^^^ * black shows diffs by default * `#207 <https://github.com/readthedocs/sphinx-autoapi/issues/207>`: Fixed a typo in the code of the golang tutorial.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I am having a problem in a larger project, but tried to condense it to a minimal example:
With the following setup
__init__.py
:something.py
:I am getting
Importing the class to one level above has the goal to condense the user-facing parts to a more concise API, this is currently a bit subverted since the imported classes are then not fully documented, only the originals are. And the warning is a bit misleading...
The text was updated successfully, but these errors were encountered: