.. _f-init:

module ``__init__``
===================







Short summary
+++++++++++++

module ``code_beatrix``

Module *code_beatrix*.







Functions
+++++++++

+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                             | truncated documentation                                                                                               |
+======================================================================+=======================================================================================================================+
| :func:`_setup_hook <code_beatrix._setup_hook>`                       | if this function is added to the module, the help automation and unit tests call it first before anything goes on ... |
+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`check <code_beatrix.check>`                                   | Checks the library is working. It raises an exception.                                                                |
+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`load_ipython_extension <code_beatrix.load_ipython_extension>` | to allow the call ``%load_ext code_beatrix``                                                                          |
+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: code_beatrix
    :members:
    :special-members: __init__
    :show-inheritance: