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

Option to disable docstring inheritance #489

Open
dhowland opened this issue Oct 9, 2024 · 0 comments
Open

Option to disable docstring inheritance #489

dhowland opened this issue Oct 9, 2024 · 0 comments

Comments

@dhowland
Copy link

dhowland commented Oct 9, 2024

I have read the sphinx-autoapi documentation thoroughly but it isn't clear exactly how Sphinx's autodoc is leveraged by sphinx-autoapi. In any case, the following does not work:

...
extensions = ['autoapi.extension', 'sphinx.ext.autodoc']
autodoc_inherit_docstrings = False
...

So there appears to be no way to instruct sphinx-autoapi not to inherit docstrings.

I would prefer being able to fine-tune autodoc directly (as above), but if that just isn't compatible with the sphinx-autoapi architecture, I would certainly settle for an equivalent of the autodoc_inherit_docstrings setting.

Edited to remove incorrect assumption

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

2 participants