Directives in the Python domain

The domain name is py. See https://www.sphinx-doc.org/en/master/usage/domains/python.html.

The py:module directive, showing the docstring for the whole module.

The second line of the module docstring.

async my_module.my_function(parameter: ParameterT = default_value) → ReturnT

The py:function directive.

async my_module.my_function_type_parameters[ParameterT](parameter: ParameterT) → ParameterT

The py:function directive, using Python 3.12 type parameters.

my_module.my_data: type = initial_value

The py:data directive.

exception my_module.MyException

The py:exception directive.

final exception my_module.MyExceptionFinal

The py:exception directive, final.

exception my_module.MyException_type_parameters(parameters)

The py:exception directive.

exception my_module.MyExceptionTypeParameters[ParameterT](parameter: ParameterT)

The py:exception directive, using Python 3.12 type parameters.

class my_module.MyClass

The py:class directive.

final class my_module.MyClassFinal

The py:class directive, final.

class my_module.MyClassParameters(parameters)

The py:class directive.

class my_module.MyClassTypeParameters[ParameterT](parameter: ParameterT)

The py:class directive, using Python 3.12 type parameters.

my_module.my_attribute: type = initial_value

The py:attribute directive.

property my_module.my_property: type

The py:property directive.

abstract class property my_module.my_property2: type

The py:property directive, using the :abstractmethod: and :classmethod: flags.

type my_module.MyType = my_module.MyType

The py:type directive.

my_module.my_method(parameters) → ReturnT

The py:method directive.

final abstractmethod async classmethod static my_module.my_method_type_parameters[ParameterT](parameter: ParameterT) → ParameterT

The py:method directive, using all of the :abstractmethod:, :async:, :classmethod:, :final:, and :staticmethod: flags, using Python 3.12 type parameters.

static my_module.my_staticmethod(parameters)

The py:staticmethod directive.

static my_module.my_staticmethod_type_parameters[ParameterT](parameter: ParameterT) → ParameterT

The py:staticmethod directive, using Python 3.12 type parameters.

classmethod my_module.my_classmethod(parameters)

The py:classmethod directive.

classmethod my_module.my_classmethod_type_parameters[ParameterT](parameter: ParameterT) → ParameterT

The py:classmethod directive, using Python 3.12 type parameters.

@my_module.my_decorator

The py:decorator directive.

@my_module.my_decorator_parameters(parameters)

The py:decorator directive.

@my_module.my_decorator_type_parameters[ParameterT](parameter: ParameterT)

The py:decorator directive, using Python 3.12 type parameters.

@my_module.my_decoratormethod

The py:decoratormethod directive.

@my_module.my_decoratormethod_signature(signature)

The py:decoratormethod directive.

@my_module.my_decoratormethod_signature_type_parameters[ParameterT](signature)

The py:decoratormethod directive, using Python 3.12 type parameters.