diff options
Diffstat (limited to 'docs/source/api.rst')
| -rw-r--r-- | docs/source/api.rst | 39 |
1 files changed, 0 insertions, 39 deletions
diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index e80684d..0000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. _api: - -API Documentation -================= - -All public API members can (and should) be imported from ``blinker``:: - - from blinker import ANY, signal - -.. currentmodule:: blinker.base - -Basic Signals -------------- - -.. autoattribute:: blinker.base.ANY - -.. autoattribute:: blinker.base.receiver_connected - -.. autoclass:: Signal - :members: - :undoc-members: - -Named Signals -------------- - -.. function:: signal(name, doc=None) - - Return the :class:`NamedSignal` *name*, creating it if required. - - Repeated calls to this function will return the same signal object. - Signals are created in a global :class:`Namespace`. - -.. autoclass:: NamedSignal - :show-inheritance: - :members: - -.. autoclass:: Namespace - :show-inheritance: - :members: signal |