mytoolbox.mymodule1

Module containing a class, global function, exception, type variable and type alias.

The type variable gets included in the list of variables captured by the template and so is automatically summarised and documented.

For some reason, the type alias doesn’t. However, it can be documented manually using the autodata directive, ie:

.. autodata:: myTypeAlias

mytoolbox.mymodule1.myTypeAlias

This is a type alias.

alias of Union[List[str], Tuple[int, int]]

Module attributes

myTypeVar

This is a type variable.

Functions

myGlobalFunction

This is a global function.

Classes

myClass1

This is a base class.

Exceptions

myError

This is a custom error.