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

Peculiar Module/Class Structure causes Build-Breaking Inheritance Diagram Error #162

Closed
michaelweinold opened this issue Sep 9, 2024 · 3 comments
Assignees
Labels

Comments

@michaelweinold michaelweinold self-assigned this Sep 9, 2024
@michaelweinold
Copy link
Contributor Author

The current remedy is to disable the 'show-inheritance-diagram' option in autoapi_options of conf.py.

@cmutel
Copy link
Member

cmutel commented Sep 14, 2024

I have looked into this, and there are a lot of libraries which use the current bw2data.parameters structure. We definitely can't just add a breaking change. My judgment is that the marginal value of these inheritance diagrams is lower than the effort to change the bw2data structure - maybe we leave the "current remedy" for now?

@michaelweinold
Copy link
Contributor Author

Sure, I will add the MWE to reproduce the issue to the issue I opened here: readthedocs/sphinx-autoapi#480. It seems like this could be fixed by the Sphinx extension.

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

No branches or pull requests

2 participants