Reference#
Directives#
- .. py:event:: event_name#
Describes a
pydispatch.dispatch.Event
object. This directive inherits from Sphinx’spy:method
directive to allow representation of arguments.- :hasargs: Indicates if there are event arguments to document (bool)#
- .. py:dispatcherproperty:: property_name#
Describes a
pydispatch.properties.Property
object. This directive inherits from Sphinx’spy:attribute
directive.- :propcls: The Property class defined (str)#
- :type: Expected type of the Property (type)#
Roles#
- :py:event:#
References a
pydispatch.dispatch.Event
object
- :py:dispatcherproperty:#
References a
pydispatch.properties.Property
object
Autodoc Directives#
The following directives are added as part of the sphinx.ext.autodoc
integration.
In most cases, they would not be used directly. The automodule
and
autoclass
directives will use them as it would for any other
class-level documenter.
- .. autoevent::#
Document
Event
objects as instance attributes using thepy:event
directive. Inherited fromautoattribute
.
- .. autoeventmethod::#
Document
Event
objects as methods using thepy:event
directive. Inherited fromautomethod
.- :hasargs: Indicates if there are arguments to document (bool)#
- .. autodispatcherproperty::#
Document
Property
objects using thepy:dispatcherproperty
directive. Inherited fromautoattribute
.- :propcls: The Property class defined (str)#
- :type: Expected type of the Property (type)#