The following two property definitions show up exactly the same in Sphinx autodoc
HTML output:
@property
def concrete(self):
"""This is the concrete docstring"""
pass
@abstractproperty
def abstract(self):
"""This is the abstract docstring"""
pass
Does Sphinx have a way to annotate the abstract methods with some kind of identifier? I'd like it to be obvious in my documentation which members of my ABC are required to implement, and which are mixin freebies you get once the required ones are defined.
It does not seem as if Sphinx is able to do that. It is marked as an open issue at Sphinx's bitbucket since 2011 and flagged as milestone for a future version of Sphinx.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With