Directives in the Python domain#
The domain name is py
. See https://www.sphinx-doc.org/en/master/usage/domains/python.html.
- my_data: type = initial_value#
The
py:data
directive.
- my_attribute: type = initial_value#
The
py:attribute
directive.
- property my_property: type#
The
py:property
directive.
- abstract class property my_property2: type#
The
py:property
directive, using the:abstractmethod:
and:classmethod:
flags.
- static my_staticmethod(parameters)#
The
py:staticmethod
directive.
- my_staticmethod_type_parameters[ParameterT](parameter: ParameterT) -> ParameterT
The
py:staticmethod
directive, using Python 3.12 type parameters.
- classmethod my_classmethod(parameters)#
The
py:classmethod
directive.
- my_classmethod_type_parameters[ParameterT](parameter: ParameterT) -> ParameterT
The
py:classmethod
directive, using Python 3.12 type parameters.
- @my_decoratormethod#
The
py:decoratormethod
directive.
- @my_decoratormethod_signature(signature)#
The
py:decoratormethod
directive.
- my_decoratormethod_signature_type_parameters[ParameterT](signature)
The
py:decoratormethod
directive, using Python 3.12 type parameters.