.. crypto_enigma documentation file

.. _home:

*************
crypto-enigma
*************

An Enigma machine simulator with rich textual display functionalty.

.. warning::

   This documentation is not yet kept in sync with the code. Its current purpose is simply to verify that
   documentation is being correctly generated.

The `crypto_enigma` package
===========================

.. automodule:: crypto_enigma

.. Several ways of creating tables of content for the documentation.

Sitemap
=======

Full contents of the documentation including subsections of each listed page.

.. toctree::
    :maxdepth: 5

    machine
    components

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

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



.. crypto_enigma documentation file

.. _home:

*************
crypto-enigma
*************

An Enigma machine simulator with rich textual display functionalty.

.. warning::

   This documentation is not yet kept in sync with the code. Its current purpose is simply to verify that
   documentation is being correctly generated.

.. note::

   Full documentation for the API currently under construction (here). In the meantime the `Hackage documentation`_
   for the `Haskell version`_ (which has essentially the same API) serves as a temporary substitute.

The `crypto_enigma` package
===========================

.. automodule:: crypto_enigma

.. Several ways of creating tables of content for the documentation.

Sitemap
=======

Full contents of the documentation including subsections of each listed page.

.. toctree::
    :maxdepth: 5

    machine
    components

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

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



Add note about state of documentation
Add note about state of documentation
