add docs

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/_themes"]
+	path = docs/_themes
+	url = git@github.com:sublee/sublee-sphinx-themes.git

README

@@ -0,0 +1,3 @@
+Elo, the classic rating system
+
+by Heungsub Lee

docs/conf.py

@@ -0,0 +1,244 @@
+# -*- coding: utf-8 -*-
+#
+# Elo documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar 26 23:27:52 2013.
+#
+# 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('_themes'))
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- 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.mathjax']
+
+# 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 = u'Elo'
+copyright = u'2013, Heungsub Lee'
+
+# 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.
+from elo import __version__ as version
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# 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 = ['_build']
+
+# 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 = 'elo'
+
+# 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 = {'github_fork': 'sublee/elo',
+                      'google_analytics': 'UA-28655602-1'}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['_themes']
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> 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 = 'favicon.ico'
+
+# 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 <link> 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 = 'elodoc'
+
+
+# -- 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', 'elo.tex', u'Elo Documentation',
+   u'Heungsub Lee', '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', 'elo', u'Elo Documentation',
+     [u'Heungsub Lee'], 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', 'elo', u'Elo Documentation',
+   u'Heungsub Lee', 'Elo', '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'

docs/index.rst

@@ -0,0 +1,72 @@
+Elo
+===
+
+the classic rating system
+
+.. currentmodule:: elo
+
+What's Elo?
+~~~~~~~~~~~
+
+Elo_ is the most famous rating system among game players. It was invented by
+`Arpad Elo`_ for chess tournaments of USCF_. ::
+
+   from elo import Rating, quality_1vs1, rate_1vs1
+   alice, bob = Rating(1000), Rating(1400)  # assign Alice and Bob's ratings
+   if quality_1vs1(alice, bob) < 0.50:
+       print('This match seems to be not so fair')
+   alice, bob = rate_1vs1(alice, bob)  # update the ratings after the match
+
+.. _Elo: http://en.wikipedia.org/wiki/Elo_rating_system
+.. _Arpad Elo: http://en.wikipedia.org/wiki/Arpad_Elo
+.. _USCF: http://www.uschess.org/
+
+Learning
+~~~~~~~~
+
+K-factor and rating extra data
+------------------------------
+
+Installing
+~~~~~~~~~~
+
+The package is available in `PyPI <http://pypi.python.org/pypi/elo>`_. To
+install it in your system, use :command:`easy_install`:
+
+.. sourcecode:: bash
+
+   $ easy_install elo
+
+Or check out developement version:
+
+.. sourcecode:: bash
+
+   $ git clone git://github.com/sublee/elo.git
+
+API
+~~~
+
+.. autoclass:: Elo
+   :members:
+
+.. autoclass:: Rating
+   :members:
+
+.. autoclass:: CountedRating
+   :members:
+
+.. autoclass:: TimedRating
+   :members:
+
+Licensing and Author
+~~~~~~~~~~~~~~~~~~~~
+
+This project is licensed under BSD_. See LICENSE_ for the details.
+
+I'm `Heungsub Lee`_, a game developer. I've also owned `the Python TrueSkill
+project <http://trueskill.org/>`_. Any regarding questions or patches are
+welcomed.
+
+.. _BSD: http://en.wikipedia.org/wiki/BSD_licenses
+.. _LICENSE: https://github.com/sublee/elo/blob/master/LICENSE
+.. _Heungsub Lee: http://subl.ee/

elo.py

@@ -52,6 +52,10 @@ def __init__(self, value=None):
         self.value = value
 
     def rated(self, value):
+        """Creates a :class:`Rating` object for the recalculated rating.
+
+        :param value: the recalculated rating value.
+        """
         return type(self)(value)
 
     def __int__(self):
@@ -141,6 +145,7 @@ def __repr__(self):
 
 
 class CountedRating(Rating):
+    """Increases count each rating recalculation."""
 
     times = None
 
@@ -155,6 +160,7 @@ def rated(self, value):
 
 
 class TimedRating(Rating):
+    """Writes the final rated time."""
 
     rated_at = None