How to comment annotation in Sphinx documentation?

The following two property definitions appear exactly the same in the output of the Sphinx autodoc html:

@property def concrete(self): """This is the concrete docstring""" pass @abstractproperty def abstract(self): """This is the abstract docstring""" pass 

Does Sphinx have the ability to annotate abstract methods with some kind of identifier? I would like this to be obvious in my documentation, which the members of my ABC must do, and which are the free mixin that you get when the required ones are defined.

+4
source share
1 answer

It seems that the Sphinx cannot do this. It has been marked as an open-ended question on Sphinx bitbucket since 2011 and is marked as a milestone for a future version of Sphinx.

0
source

Source: https://habr.com/ru/post/1493264/


All Articles