# HG changeset patch # User Brian Neal # Date 1338515723 18000 # Node ID 5c33e81fbc7d6458535e251def44eaa796b4132c # Parent 560ded21dcd9e86987495543e3ed0df097247b2c Just getting starting with some Sphinx documentation. diff -r 560ded21dcd9 -r 5c33e81fbc7d .hgignore --- a/.hgignore Wed May 30 20:08:15 2012 -0500 +++ b/.hgignore Thu May 31 20:55:23 2012 -0500 @@ -1,3 +1,5 @@ syntax: glob *.pyc *.swp +enigma/docs/build +dist diff -r 560ded21dcd9 -r 5c33e81fbc7d enigma/docs/Makefile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/enigma/docs/Makefile Thu May 31 20:55:23 2012 -0500 @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Py-Enigma.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Py-Enigma.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Py-Enigma" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Py-Enigma" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff -r 560ded21dcd9 -r 5c33e81fbc7d enigma/docs/source/conf.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/enigma/docs/source/conf.py Thu May 31 20:55:23 2012 -0500 @@ -0,0 +1,244 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Py-Enigma documentation build configuration file, created by +# sphinx-quickstart on Thu May 31 19:11:09 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. + +sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..'))) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Py-Enigma' +copyright = '2012, Brian Neal' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Py-Enigmadoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Py-Enigma.tex', 'Py-Enigma Documentation', + 'Brian Neal', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'py-enigma', 'Py-Enigma Documentation', + ['Brian Neal'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Py-Enigma', 'Py-Enigma Documentation', + 'Brian Neal', 'Py-Enigma', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff -r 560ded21dcd9 -r 5c33e81fbc7d enigma/docs/source/index.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/enigma/docs/source/index.rst Thu May 31 20:55:23 2012 -0500 @@ -0,0 +1,30 @@ +.. 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 +:Version: |release| +:Date: |today| +:Home Page: https://bitbucket.org/bgneal/enigma/ +:License: MIT License (see LICENSE.txt) +:Support: https://bitbucket.org/bgneal/enigma/issues + +Contents: + +.. toctree:: + :maxdepth: 2 + + overview + library + pyenigma + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff -r 560ded21dcd9 -r 5c33e81fbc7d enigma/docs/source/library.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/enigma/docs/source/library.rst Thu May 31 20:55:23 2012 -0500 @@ -0,0 +1,8 @@ +Library Documentation +===================== + +EnigmaMachine Class Reference +----------------------------- + +.. autoclass:: enigma.machine.EnigmaMachine + :members: diff -r 560ded21dcd9 -r 5c33e81fbc7d enigma/docs/source/overview.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/enigma/docs/source/overview.rst Thu May 31 20:55:23 2012 -0500 @@ -0,0 +1,118 @@ +Overview +======== + +Introduction +------------ + +**Py-Enigma** is a Python 3 library for simulating the `Enigma machines`_ used +by the German armed forces (*Wehrmacht*) during World War II. Py-Enigma is +historically accurate, meaning it can interoperate with actual Wehrmacht Enigma +machines. In other words, Py-Enigma can decrypt coded messages created with an +actual Enigma, and it can encrypt messages that an actual Enigma can decode. + +It is hoped that this library will be useful to Enigma enthusiasts, historians, +and students interested in cryptography. + +Py-Enigma strives to be Pythonic, easy to use, and comes with both unit tests +and documentation. Py-Enigma is a library for building applications for +encrypting and decrypting Enigma messages. However, it also ships with a simple +command-line application that can encrypt & decrypt messages for scripting and +experimentation. + +Scope +----- + +Currently, Py-Enigma simulates the Wehrmacht Enigma machines. This includes the +3 and 4 rotor machines used by the German Army (*Heer*), Air Force +(*Luftwaffe*), and Navy (*Kriegsmarine*). Simulation of other Enigma models, +including the various commercial, railroad, foreign market, and Abhwer (Military +Intelligence) models may come later if there is enough interest and data +available. + +Quick Example +------------- + +This example shows how the library can be used to decode a message using the +procedure employed by the German army + +.. literalinclude:: ../../examples/example1.py + +This program prints:: + + THEXRUSSIANSXAREXCOMINGX + +Py-Enigma also includes a command-line application for processing messages. +Assuming you have a proper key file that contains the same initial settings as +the code above, the above example can be performed on the command-line:: + + $ pyenigma.py --key-file=keys.txt --start=WXC --text='KCH' + BLA + $ pyenigma.py --key-file=keys.txt --start=BLA --text='NIBLFMYMLLUFWCASCSSNVHAZ' + THEXRUSSIANSXAREXCOMINGX + +The format of the key file can be found in the documentation for pyenigma.py. + +Requirements +------------ + +Py-Enigma is written in Python_, specifically Python 3.2. It has no other +requirements or dependencies. + +Installation +------------ + +To install or upgrade via PyPI_ use pip_:: + + pip install pyenigma # install + pip install --upgrade pyenigma # upgrade + +Alternatively you can download a source .zip or tarball at the `Py-Enigma +Bitbucket page`_. Once unpacked, you can install with:: + + python setup.py install + + +Support & Source +---------------- + +All support takes place at the `Py-Enigma Bitbucket page`_. Please enter any +feature requests or bugs into the `issue tracker`_. + +You may also clone the Mercurial_ source code repository:: + + $ hg clone https://bitbucket.org/bgneal/enigma + + +Acknowledgements & References +----------------------------- + +This software would not have been possible without the thorough and detailed +descriptions of the Enigma machine on Dirk Rijmenants' incredible `Cipher +Machines and Cryptology website`_. In particular, his `Technical Details of the +Enigma Machine`_ page was a gold mine of information. + +Dirk has also written an `Enigma simulator`_ in Visual Basic. Although I did not +look at his source code, I did use his simulator to check the operation of +Py-Enigma. + +I would also like to recommend the photos and video at Dr. Thomas B. Perera's +`Enigma Museum`_. + +Another good website is `The Enigma and the Bombe`_ by Graham Ellsbury. + +A nice video which shows the basic components and operation of the Enigma +Machine is on YouTube: `Nadia Baker & Enigma demo`_. + +.. _Enigma machines: http://en.wikipedia.org/wiki/Enigma_machine +.. _Python: http://www.python.org +.. _PyPI: http://pypi.python.org/pypi +.. _Py-Enigma Bitbucket page: https://bitbucket.org/bgneal/enigma +.. _pip: http://www.pip-installer.org +.. _Mercurial: http://mercurial.selenic.com/ +.. _issue tracker: https://bitbucket.org/bgneal/enigma/issues +.. _Cipher Machines and Cryptology website: http://users.telenet.be/d.rijmenants/index.htm +.. _Technical Details of the Enigma Machine: http://users.telenet.be/d.rijmenants/en/enigmatech.htm +.. _Enigma simulator: http://users.telenet.be/d.rijmenants/en/enigmasim.htm +.. _Enigma Museum: http://w1tp.com/enigma/ +.. _The Enigma and the Bombe: http://www.ellsbury.com/enigmabombe.htm +.. _Nadia Baker & Enigma demo: http://youtu.be/HBHYAzuVeWc