pydocmaker.backend.ex_typst
===========================

.. py:module:: pydocmaker.backend.ex_typst


Attributes
----------

.. autoapisummary::

   pydocmaker.backend.ex_typst.log
   pydocmaker.backend.ex_typst.__default_template
   pydocmaker.backend.ex_typst._table_template
   pydocmaker.backend.ex_typst._figure_template
   pydocmaker.backend.ex_typst.DATA_URI_IMAGE_RE


Classes
-------

.. autoapisummary::

   pydocmaker.backend.ex_typst.DocumentTypstFormatter


Functions
---------

.. autoapisummary::

   pydocmaker.backend.ex_typst.test_typst_installed
   pydocmaker.backend.ex_typst.to_typst_string
   pydocmaker.backend.ex_typst._compile
   pydocmaker.backend.ex_typst.compile_with_typst
   pydocmaker.backend.ex_typst.convert


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

.. py:data:: log

.. py:data:: __default_template
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """
      
      #set page("a4")
      
      #show link: set text(fill: blue, weight: 700)
      #show link: underline
      
      // code blocks
      #let code-border = luma(0)
      #show raw.where(block: false): set text(weight: "semibold")
      #show raw.where(block: true): set text(size: 0.8em)
      #show raw.where(block: true): it => {
          block(
              width:100%,
              inset: 10pt,
              radius: 4pt,
              stroke: 0.1pt + code-border,
              it,
          )
      }
      
      #set figure(numbering: "1")
      #set figure.caption(separator: " - ") // With a nice separator
      #set math.equation(numbering: "(1)", supplement: "Eq.")
      
      {{ body}}
      
      """

   .. raw:: html

      </details>



.. py:data:: _table_template
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """
      #figure(
      table(
          columns: {n_cols:},
          stroke: {stroke:},
          align:(left+horizon),
          {header:}
          {rows:}
      ),
      {suffix:}
      ) <{name:}>
      
      """

   .. raw:: html

      </details>



.. py:data:: _figure_template
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """
      #figure(
        image(base64.decode({name:}), {width:} format: "{ext:}"),
        {suffix:}
      ) <{name:}>
      """

   .. raw:: html

      </details>



.. py:data:: DATA_URI_IMAGE_RE

.. py:function:: test_typst_installed()

.. py:function:: to_typst_string(text)

.. py:function:: _compile(verb, on_warning, **kw)

.. py:function:: compile_with_typst(typst_code: Union[str, List[dict]], output: str = None, verb=1, on_warning='warn', format=None, attachments=None, **kwargs)

.. py:function:: convert(doc: List[dict], template=None, template_params=None, ret_attachments=False, **kwargs)

.. py:class:: DocumentTypstFormatter

   Bases: :py:obj:`pydocmaker.backend.baseformatter.BaseFormatter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: cnt_img
      :value: 0



   .. py:attribute:: cnt_tables
      :value: 0



   .. py:attribute:: libraries


   .. py:method:: _handle_color(part, color=None, **kwargs)


   .. py:method:: digest_latex(children: str, **kwargs)


   .. py:method:: digest_markdown(children='', **kwargs) -> list


   .. py:method:: digest_text(children='', **kwargs)


   .. py:method:: digest_table(children=None, **kwargs) -> str


   .. py:method:: digest_image(**kwargs) -> list


   .. py:method:: digest_verbatim(children='', **kwargs) -> list