pydocmaker.backend.mdx_latex
============================

.. py:module:: pydocmaker.backend.mdx_latex


Attributes
----------

.. autoapisummary::

   pydocmaker.backend.mdx_latex.start_single_quote_re
   pydocmaker.backend.mdx_latex.start_double_quote_re
   pydocmaker.backend.mdx_latex.end_double_quote_re


Classes
-------

.. autoapisummary::

   pydocmaker.backend.mdx_latex.LaTeXExtension
   pydocmaker.backend.mdx_latex.LaTeXTreeProcessor
   pydocmaker.backend.mdx_latex.UnescapeHtmlTextPostProcessor
   pydocmaker.backend.mdx_latex.MathTextPostProcessor
   pydocmaker.backend.mdx_latex.TableTextPostProcessor
   pydocmaker.backend.mdx_latex.Table2Latex
   pydocmaker.backend.mdx_latex.ImageTextPostProcessor
   pydocmaker.backend.mdx_latex.Img2Latex
   pydocmaker.backend.mdx_latex.LinkTextPostProcessor
   pydocmaker.backend.mdx_latex.Link2Latex
   pydocmaker.backend.mdx_latex.FootnoteExtension


Functions
---------

.. autoapisummary::

   pydocmaker.backend.mdx_latex.replace_underscores
   pydocmaker.backend.mdx_latex.inline_html_latex
   pydocmaker.backend.mdx_latex.unescape_html_entities
   pydocmaker.backend.mdx_latex.escape_latex_entities
   pydocmaker.backend.mdx_latex.unescape_latex_entities
   pydocmaker.backend.mdx_latex.makeExtension
   pydocmaker.backend.mdx_latex.template
   pydocmaker.backend.mdx_latex.main


Module Contents
---------------

.. py:data:: start_single_quote_re

.. py:data:: start_double_quote_re

.. py:data:: end_double_quote_re

.. py:function:: replace_underscores(s)

.. py:function:: inline_html_latex(text)

.. py:function:: unescape_html_entities(text)

.. py:function:: escape_latex_entities(text)

   Escape latex reserved characters.


.. py:function:: unescape_latex_entities(text)

   Limit ourselves as this is only used for maths stuff.


.. py:function:: makeExtension(configs=None)

.. py:class:: LaTeXExtension(configs=None)

   Bases: :py:obj:`markdown.Extension`


   .. py:method:: extendMarkdown(md)


   .. py:method:: reset()


.. py:class:: LaTeXTreeProcessor

   Bases: :py:obj:`markdown.treeprocessors.Treeprocessor`


   .. py:method:: run(doc)

      Walk the dom converting relevant nodes to text nodes with relevant
      content.



   .. py:method:: tolatex(ournode)


.. py:class:: UnescapeHtmlTextPostProcessor

   Bases: :py:obj:`markdown.postprocessors.Postprocessor`


   .. py:method:: run(text)


.. py:class:: MathTextPostProcessor

   Bases: :py:obj:`markdown.postprocessors.Postprocessor`


   .. py:method:: run(instr)

      Convert all math sections in {text} whether latex, asciimathml or
      latexmathml formatted to latex.

      This assumes you are using $ for inline math and $$ for blocks as your
      mathematics delimiter (*not* the standard asciimathml or latexmathml
      delimiter).



.. py:class:: TableTextPostProcessor

   Bases: :py:obj:`markdown.postprocessors.Postprocessor`


   .. py:method:: run(instr)

      This is not very sophisticated and for it to work it is expected
      that:
          1. tables to be in a section on their own (that is at least one
          blank line above and below)
          2. no nesting of tables



.. py:class:: Table2Latex

   Convert html tables to Latex.

   TODO: escape latex entities.


   .. py:method:: colformat()


   .. py:method:: get_text(element)


   .. py:method:: process_cell(element)


   .. py:method:: tolatex(element)


   .. py:method:: convert(instr)


.. py:class:: ImageTextPostProcessor

   Bases: :py:obj:`markdown.postprocessors.Postprocessor`


   .. py:method:: run(instr)

      Process all img tags

      Similar to process_tables this is not very sophisticated and for it
      to work it is expected that img tags are put in a section of their own
      (that is separated by at least one blank line above and below).



.. py:class:: Img2Latex

   Bases: :py:obj:`object`


   .. py:method:: convert(instr)


.. py:class:: LinkTextPostProcessor

   Bases: :py:obj:`markdown.postprocessors.Postprocessor`


   .. py:method:: run(instr)


.. py:class:: Link2Latex

   Bases: :py:obj:`object`


   .. py:method:: convert(instr)


.. py:class:: FootnoteExtension(configs=None)

   Bases: :py:obj:`markdown.Extension`


   .. py:attribute:: DEF_RE


   .. py:attribute:: SHORT_USE_RE


   .. py:method:: extendMarkdown(md)


   .. py:method:: reset()


   .. py:method:: setFootnote(id, text)


.. py:function:: template(template_fo, latex_to_insert)

.. py:function:: main()