.. _f-latexfile:

module ``homeblog.latex_file``
==============================





.. inheritance-diagram:: ensae_teaching_cs.homeblog.latex_file


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

module ``ensae_teaching_cs.homeblog.latex_file``

Ths file contains some functions to extract pieces of codes from a latex file


:githublink:`%|py|5`




Classes
+++++++

+--------------------------------------------------------------------------------------+------------------------------------------------------------------+
| class                                                                                | truncated documentation                                          |
+======================================================================================+==================================================================+
| :class:`LatexCode <ensae_teaching_cs.homeblog.latex_file.LatexCode>`                 | many latex contains examples of codes this describes one of them |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :class:`LatexFile <ensae_teaching_cs.homeblog.latex_file.LatexFile>`                 | Description of a latex file.                                     |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :class:`LatexIncludedFile <ensae_teaching_cs.homeblog.latex_file.LatexIncludedFile>` | Describes a file included a latex file.                          |
+--------------------------------------------------------------------------------------+------------------------------------------------------------------+








Static Methods
++++++++++++++

+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| staticmethod                                                                            | truncated documentation                                           |
+=========================================================================================+===================================================================+
| :meth:`dichotomy_find <ensae_teaching_cs.homeblog.latex_file.LatexFile.dichotomy_find>` | find the greatest position which contains a value below ``value`` |
+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| method                                                                                          | truncated documentation                                                                                       |
+=================================================================================================+===============================================================================================================+
| :py:meth:`__init__ <ensae_teaching_cs.homeblog.latex_file.LatexCode.__init__>`                  | constructor                                                                                                   |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <ensae_teaching_cs.homeblog.latex_file.LatexFile.__init__>`                  | constructor                                                                                                   |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <ensae_teaching_cs.homeblog.latex_file.LatexIncludedFile.__init__>`          |                                                                                                               |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <ensae_teaching_cs.homeblog.latex_file.LatexCode.__str__>`                    | usual                                                                                                         |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <ensae_teaching_cs.homeblog.latex_file.LatexFile.__str__>`                    | usual                                                                                                         |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`code_in_html <ensae_teaching_cs.homeblog.latex_file.LatexFile.code_in_html>`             | produces html format containing all the code example                                                          |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_code <ensae_teaching_cs.homeblog.latex_file.LatexFile.enumerate_code>`         | enumerate all pieces of code (in ``verbatim``, ``verbatimx`` or ``\inputcode`` sections                       |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_code <ensae_teaching_cs.homeblog.latex_file.LatexIncludedFile.enumerate_code>` | Enumerates all pieces of code (in ``verbatim``, ``verbatimx`` or ``\inputcode`` sections.                     |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`init <ensae_teaching_cs.homeblog.latex_file.LatexIncludedFile.init>`                     | Completes the contructor.                                                                                     |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`read <ensae_teaching_cs.homeblog.latex_file.LatexFile.read>`                             | read the latex file and stores into ``self.content``, if the method is called a second time, the function ... |
+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+


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

.. automodule:: ensae_teaching_cs.homeblog.latex_file
    :members:
    :special-members: __init__
    :show-inheritance: