drawio2py/docs/index.rst

.. DrawioConvert documentation master file, created by
   sphinx-quickstart on Tue Dec 29 15:01:45 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to DrawioConvert's documentation!
=========================================

:code:`DrawioConvert` is a project that allows conversion from simple, yet
structured `draw.io <https://www.diagrams.net>`_ diagrams to any kind of file.
This usually provides a useful entrypoint for visual modelling of models that
comply to a textual framework.

Or, more specifically, this tool allows for the creation of graphical
interfaces for code frameworks. Note that, while this tool was written in
Python, any language is possible thanks to
`Jinja 2 <https://jinja.palletsprojects.com/en/2.11.x/>`_.

Requirements
------------
* Standard Libraries:
   * :code:`xml` (for :code:`xml.etree.ElementTree`)
   * :code:`urllib` (for :code:`urllib.parse.unquote`)
   * :code:`argparse`
   * :code:`base64`
   * :code:`os`
   * :code:`re`
   * :code:`sys`
   * :code:`zlib`
* External Libraries:
   * `Jinja 2 <https://jinja.palletsprojects.com/en/2.11.x/>`_
   * Anything else that is required for the converted files to work.

.. warning::
     :code:`DrawioConvert` does not execute the converted files, but only
     generates them! The user is required to install all components for the
     formalisms they like to use themselves.

How Does It Work?
-----------------
The core idea behind :code:`DrawioConvert` is the use of so-called "formalisms".
These are generic descriptions of how certain drawio files can (and should) be
interpreted. They are provided with some setup information, a few template
files, a drawio library and some documentation on their usage. From any drawio
file (made according to the specification identified by the formalism) a new
one will be generated that is complient with the drawn diagram and the selected
formalism.

This also allows drawio to be used for any block-based modelling language for
which a graphical representation can be given and code generation can be
defined.

Quick Links
-----------
.. toctree::
   :maxdepth: 4

   execute
   formalisms/create

Builtin Formalisms
------------------
.. toctree::
   :maxdepth: 1

   formalisms/CBD

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`