You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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
The text was updated successfully, but these errors were encountered:
please, this would be very helpful. The unittest.TestCase type has an issue with its docstring, when I inherit from it, it adds the docstring in the output and raises an error for a text I didn't write.
I'm also interested in how to accomplish this, for the same reason as the original requester. I need just that specific option, but some way to generally pass-through options to autodoc would be cool.
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:
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
The text was updated successfully, but these errors were encountered: