.. _l-functions:

Functions
=========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+----------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                             | class parent | truncated documentation                                                                                               |
+======================================================================+==============+=======================================================================================================================+
| :func:`_setup_hook <lecture_citation._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 <lecture_citation.check>`                               |              | Checks the library is working. It raises an exception. If you want to disable the logs:                               |
+----------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_quotes <lecture_citation.fromtex.enumerate_quotes>` |              | Enumerates quote from a filename or a stream                                                                          |
+----------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`to_rst <lecture_citation.torst.to_rst>`                       |              | Converts a quote defined as a dictionary into :epkg:`rst`.                                                            |
+----------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+