Github Pages: Adds missing pages

author: Ask Solem <ask@celeryproject.org> 2011-09-07 16:26:19 +0100
committer: Ask Solem <ask@celeryproject.org> 2011-09-07 16:26:19 +0100
commit: 8598251b22046e93ed649258f724d6d371e0342f (patch)
tree: b0b34343970e837d64e8e0ffe8e0d028dcf6a37e
parent: e6f69c13aaff8da0c64ce8f744e78153f78c9df2 (diff)
download: kombu-8598251b22046e93ed649258f724d6d371e0342f.tar.gz
4 files changed, 315 insertions, 0 deletions
diff --git a/_sources/reference/kombu.clocks.txt b/_sources/reference/kombu.clocks.txt
new file mode 100644
index 00000000..9f49cff3
--- /dev/null
+++ b/_sources/reference/kombu.clocks.txt
@@ -0,0 +1,11 @@
+==========================================================
+ Clocks and Synchronization - kombu.clocks
+==========================================================
+
+.. contents::
+    :local:
+.. currentmodule:: kombu.clocks
+
+.. automodule:: kombu.clocks
+    :members:
+    :undoc-members:
diff --git a/_sources/reference/kombu.common.txt b/_sources/reference/kombu.common.txt
new file mode 100644
index 00000000..01eee9b2
--- /dev/null
+++ b/_sources/reference/kombu.common.txt
@@ -0,0 +1,11 @@
+==========================================================
+ Common Utilities - kombu.common
+==========================================================
+
+.. contents::
+    :local:
+.. currentmodule:: kombu.common
+
+.. automodule:: kombu.common
+    :members:
+    :undoc-members:
diff --git a/reference/kombu.clocks.html b/reference/kombu.clocks.html
new file mode 100644
index 00000000..90fa5d88
--- /dev/null
+++ b/reference/kombu.clocks.html
@@ -0,0 +1,169 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Clocks and Synchronization - kombu.clocks &mdash; Kombu v1.3.1 documentation</title>
+    <link rel="stylesheet" href="../_static/celery.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '1.3.1',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="top" title="Kombu v1.3.1 documentation" href="../index.html" />
+    <link rel="up" title="API Reference" href="index.html" />
+    <link rel="next" title="kombu.compat" href="kombu.compat.html" />
+    <link rel="prev" title="Common Utilities - kombu.common" href="kombu.common.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="kombu.compat.html" title="kombu.compat"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="kombu.common.html" title="Common Utilities - kombu.common"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../index.html">Kombu v1.3.1 documentation</a> &raquo;</li>
+          <li><a href="index.html" accesskey="U">API Reference</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <div class="section" id="clocks-and-synchronization-kombu-clocks">
+<h1>Clocks and Synchronization - kombu.clocks<a class="headerlink" href="#clocks-and-synchronization-kombu-clocks" title="Permalink to this headline">¶</a></h1>
+<span class="target" id="module-kombu.clocks"></span><dl class="class">
+<dt id="kombu.clocks.LamportClock">
+<em class="property">class </em><tt class="descclassname">kombu.clocks.</tt><tt class="descname">LamportClock</tt><big>(</big><em>initial_value=0</em><big>)</big><a class="headerlink" href="#kombu.clocks.LamportClock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Lamport&#8217;s logical clock.</p>
+<p>From Wikipedia:</p>
+<p>&#8220;A Lamport logical clock is a monotonically incrementing software counter
+maintained in each process.  It follows some simple rules:</p>
+<blockquote>
+<div><ul class="simple">
+<li>A process increments its counter before each event in that process;</li>
+<li>When a process sends a message, it includes its counter value with
+the message;</li>
+<li>On receiving a message, the receiver process sets its counter to be
+greater than the maximum of its own value and the received value
+before it considers the message received.</li>
+</ul>
+</div></blockquote>
+<p>Conceptually, this logical clock can be thought of as a clock that only
+has meaning in relation to messages moving between processes.  When a
+process receives a message, it resynchronizes its logical clock with
+the sender.</p>
+<div class="admonition-see-also admonition seealso">
+<p class="first admonition-title">See also</p>
+<p><a class="reference external" href="http://en.wikipedia.org/wiki/Lamport_timestamps">http://en.wikipedia.org/wiki/Lamport_timestamps</a>
+<a class="reference external" href="http://en.wikipedia.org/wiki/Lamport">http://en.wikipedia.org/wiki/Lamport</a>&#8216;<a href="#id1"><span class="problematic" id="id2">s_Distributed_</span></a></p>
+<blockquote class="last">
+<div>Mutual_Exclusion_Algorithm</div></blockquote>
+</div>
+<p><em>Usage</em></p>
+<p>When sending a message use <a class="reference internal" href="#kombu.clocks.LamportClock.forward" title="kombu.clocks.LamportClock.forward"><tt class="xref py py-meth docutils literal"><span class="pre">forward()</span></tt></a> to increment the clock,
+when receiving a message use <a class="reference internal" href="#kombu.clocks.LamportClock.adjust" title="kombu.clocks.LamportClock.adjust"><tt class="xref py py-meth docutils literal"><span class="pre">adjust()</span></tt></a> to sync with
+the time stamp of the incoming message.</p>
+<dl class="method">
+<dt id="kombu.clocks.LamportClock.adjust">
+<tt class="descname">adjust</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#kombu.clocks.LamportClock.adjust" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="kombu.clocks.LamportClock.forward">
+<tt class="descname">forward</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.clocks.LamportClock.forward" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="kombu.clocks.LamportClock.value">
+<tt class="descname">value</tt><a class="headerlink" href="#kombu.clocks.LamportClock.value" title="Permalink to this definition">¶</a></dt>
+<dd><p>The clocks current value.</p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper"><p class="logo"><a href="../index.html">
+  <img class="logo" width="128" height="128" src="http://cloud.github.com/downloads/ask/kombu/kombusmall.jpg" alt="Logo"/>
+</a></p>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="kombu.common.html"
+                        title="previous chapter">Common Utilities - kombu.common</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="kombu.compat.html"
+                        title="next chapter">kombu.compat</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/reference/kombu.clocks.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" size="18" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="kombu.compat.html" title="kombu.compat"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="kombu.common.html" title="Common Utilities - kombu.common"
+             >previous</a> |</li>
+        <li><a href="../index.html">Kombu v1.3.1 documentation</a> &raquo;</li>
+          <li><a href="index.html" >API Reference</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2011, Ask Solem.
+      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
+    </div>
+  </body>
+</html>
+\ No newline at end of file
diff --git a/reference/kombu.common.html b/reference/kombu.common.html
new file mode 100644
index 00000000..a94f2c27
--- /dev/null
+++ b/reference/kombu.common.html
@@ -0,0 +1,124 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Common Utilities - kombu.common &mdash; Kombu v1.3.1 documentation</title>
+    <link rel="stylesheet" href="../_static/celery.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '1.3.1',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="top" title="Kombu v1.3.1 documentation" href="../index.html" />
+    <link rel="up" title="API Reference" href="index.html" />
+    <link rel="next" title="Clocks and Synchronization - kombu.clocks" href="kombu.clocks.html" />
+    <link rel="prev" title="kombu.entity" href="kombu.entity.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="kombu.clocks.html" title="Clocks and Synchronization - kombu.clocks"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="kombu.entity.html" title="kombu.entity"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../index.html">Kombu v1.3.1 documentation</a> &raquo;</li>
+          <li><a href="index.html" accesskey="U">API Reference</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <div class="section" id="common-utilities-kombu-common">
+<h1>Common Utilities - kombu.common<a class="headerlink" href="#common-utilities-kombu-common" title="Permalink to this headline">¶</a></h1>
+<span class="target" id="module-kombu.common"></span><dl class="function">
+<dt id="kombu.common.entry_to_queue">
+<tt class="descclassname">kombu.common.</tt><tt class="descname">entry_to_queue</tt><big>(</big><em>queue</em>, <em>**options</em><big>)</big><a class="headerlink" href="#kombu.common.entry_to_queue" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper"><p class="logo"><a href="../index.html">
+  <img class="logo" width="128" height="128" src="http://cloud.github.com/downloads/ask/kombu/kombusmall.jpg" alt="Logo"/>
+</a></p>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="kombu.entity.html"
+                        title="previous chapter">kombu.entity</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="kombu.clocks.html"
+                        title="next chapter">Clocks and Synchronization - kombu.clocks</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/reference/kombu.common.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" size="18" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="kombu.clocks.html" title="Clocks and Synchronization - kombu.clocks"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="kombu.entity.html" title="kombu.entity"
+             >previous</a> |</li>
+        <li><a href="../index.html">Kombu v1.3.1 documentation</a> &raquo;</li>
+          <li><a href="index.html" >API Reference</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2011, Ask Solem.
+      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
+    </div>
+  </body>
+</html>
+\ No newline at end of file
author	Ask Solem <ask@celeryproject.org>	2011-09-07 16:26:19 +0100
committer	Ask Solem <ask@celeryproject.org>	2011-09-07 16:26:19 +0100
commit	8598251b22046e93ed649258f724d6d371e0342f (patch)
tree	b0b34343970e837d64e8e0ffe8e0d028dcf6a37e
parent	e6f69c13aaff8da0c64ce8f744e78153f78c9df2 (diff)
download	kombu-8598251b22046e93ed649258f724d6d371e0342f.tar.gz