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

[Feature Request] support :inherited-members: and :show-inheritance: #183

Closed
lukehsiao opened this issue Nov 13, 2019 · 3 comments
Closed

Comments

@lukehsiao
Copy link

One of the key selling points of autoapi is that unlike autodoc, it does not need to load, run, or import the project being documented. However, autoapi current does not support showing inheritance or inherited members (see autoapi_options in https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html.

To be a viable replacement for autodocs in our use case, we would like support for :inherited-members: and :show-inheritance:.

AWhetter added a commit that referenced this issue Feb 1, 2020
Also turned autoapi_include_inheritance_graphs into a
show-inheritance-diagram AutoAPI option to be more consistent
with show-inheritance.

Partially implements #183
@timokau
Copy link

timokau commented Mar 19, 2021

Is there any example project that uses this? I tried to enable the :show-inheritance: option for our project, but it seems to have no effect.

  • Here is the conf.py.
  • Here is a superclass that defines the feedback_mechanism attribute.
  • Here is a subclass that inherits that attribute.
  • Here are the rendered docs of the attribute in the superclass.
  • Here are the rendered docs of the subclass, not including the attribute documentation.
  • Here are the logs of the documentation build using sphinx-autoapi 1.7.0.

@AWhetter could you have a look? Am I doing something wrong?

@AWhetter
Copy link
Collaborator

This is a different bug. AutoAPI is currently ignoring inherited attributes. Please could you make a separate issue for the problem.

@timokau
Copy link

timokau commented Mar 22, 2021

Thanks for the response. I have opened #272.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants