.. Py-Enigma documentation master file, created by
   sphinx-quickstart on Thu May 31 19:11:09 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Py-Enigma's documentation!
=====================================

:Author: Brian Neal <bgneal@gmail.com>
:Version: |release|
:Date: |today|
:Home Page: https://bitbucket.org/bgneal/enigma/
:License: MIT License (see LICENSE.txt)
:Documentation: http://py-enigma.readthedocs.org/
:Support: https://bitbucket.org/bgneal/enigma/issues

Py-Enigma is a historically accurate `Enigma machine
<http://en.wikipedia.org/wiki/Enigma_machine>`_ simulation library written in
Python. Py-Enigma includes a simple command-line application to allow for quick
experimenting and scripting.

Documentation contents:

.. toctree::
   :maxdepth: 3

   overview
   guide
   reference
   pyenigma
   keyfile

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

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