Skip to content

Option to disable docstring inheritance #489

Open
@dhowland

Description

@dhowland

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions