Rendered documentation for Github Pages.

Author: Ask Solem

changelog.html

@@ -56,8 +56,15 @@ <h3>Navigation</h3>
 <h1>Running celeryd as a daemon<a class="headerlink" href="#running-celeryd-as-a-daemon" title="Permalink to this headline">¶</a></h1>
 <p>Celery does not daemonize itself, please use one of the following
 daemonization tools.</p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference external" href="#start-stop-daemon" id="id2">start-stop-daemon</a></li>
+<li><a class="reference external" href="#supervisord" id="id3">supervisord</a></li>
+<li><a class="reference external" href="#launchd-os-x" id="id4">launchd (OS X)</a></li>
+</ul>
+</div>
 <div class="section" id="start-stop-daemon">
-<h2>start-stop-daemon<a class="headerlink" href="#start-stop-daemon" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id2">start-stop-daemon</a><a class="headerlink" href="#start-stop-daemon" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="http://github.com/ask/celery/tree/master/contrib/debian/">contrib/debian/init.d/</a></li>
 </ul>
@@ -69,7 +76,7 @@ <h2><a class="reference external" href="http://supervisord.org/">supervisord</a>
 </ul>
 </div>
 <div class="section" id="launchd-os-x">
-<h2>launchd (OS X)<a class="headerlink" href="#launchd-os-x" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id4">launchd (OS X)</a><a class="headerlink" href="#launchd-os-x" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="http://github.com/ask/celery/tree/master/contrib/mac/">contrib/mac/</a></li>
 </ul>

configuration.html

@@ -54,8 +54,13 @@ <h3>Navigation</h3>
 
   <div class="section" id="creating-tasks">
 <h1>Creating Tasks<a class="headerlink" href="#creating-tasks" title="Permalink to this headline">¶</a></h1>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference external" href="#ensuring-a-task-is-only-executed-one-at-a-time" id="id1">Ensuring a task is only executed one at a time</a></li>
+</ul>
+</div>
 <div class="section" id="ensuring-a-task-is-only-executed-one-at-a-time">
-<h2>Ensuring a task is only executed one at a time<a class="headerlink" href="#ensuring-a-task-is-only-executed-one-at-a-time" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id1">Ensuring a task is only executed one at a time</a><a class="headerlink" href="#ensuring-a-task-is-only-executed-one-at-a-time" title="Permalink to this headline">¶</a></h2>
 <p>You can accomplish this by using a lock.</p>
 <p>In this example we&#8217;ll be using the cache framework to set a lock that is
 accessible for all workers.</p>

cookbook/daemonizing.html

@@ -54,13 +54,24 @@ <h3>Navigation</h3>
 
   <div class="section" id="broker-installation">
 <h1>Broker Installation<a class="headerlink" href="#broker-installation" title="Permalink to this headline">¶</a></h1>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference external" href="#installing-rabbitmq" id="id2">Installing RabbitMQ</a></li>
+<li><a class="reference external" href="#setting-up-rabbitmq" id="id3">Setting up RabbitMQ</a></li>
+<li><a class="reference external" href="#installing-rabbitmq-on-os-x" id="id4">Installing RabbitMQ on OS X</a><ul>
+<li><a class="reference external" href="#configuring-the-system-hostname" id="id5">Configuring the system hostname</a></li>
+<li><a class="reference external" href="#starting-stopping-the-rabbitmq-server" id="id6">Starting/Stopping the RabbitMQ server</a></li>
+</ul>
+</li>
+</ul>
+</div>
 <div class="section" id="installing-rabbitmq">
-<h2>Installing RabbitMQ<a class="headerlink" href="#installing-rabbitmq" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id2">Installing RabbitMQ</a><a class="headerlink" href="#installing-rabbitmq" title="Permalink to this headline">¶</a></h2>
 <p>See <a class="reference external" href="http://www.rabbitmq.com/install.html">Installing RabbitMQ</a> over at RabbitMQ&#8217;s website. For Mac OS X
 see <a class="reference external" href="#installing-rabbitmq-on-os-x">Installing RabbitMQ on OS X</a>.</p>
 </div>
 <div class="section" id="setting-up-rabbitmq">
-<h2>Setting up RabbitMQ<a class="headerlink" href="#setting-up-rabbitmq" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id3">Setting up RabbitMQ</a><a class="headerlink" href="#setting-up-rabbitmq" title="Permalink to this headline">¶</a></h2>
 <p>To use celery we need to create a RabbitMQ user, a virtual host and
 allow that user access to that virtual host:</p>
 <div class="highlight-python"><pre>$ rabbitmqctl add_user myuser mypassword
@@ -72,7 +83,7 @@ <h2>Setting up RabbitMQ<a class="headerlink" href="#setting-up-rabbitmq" title="
 <p>See the RabbitMQ <a class="reference external" href="http://www.rabbitmq.com/admin-guide.html">Admin Guide</a> for more information about <a class="reference external" href="http://www.rabbitmq.com/admin-guide.html#access-control">access control</a>.</p>
 </div>
 <div class="section" id="installing-rabbitmq-on-os-x">
-<h2>Installing RabbitMQ on OS X<a class="headerlink" href="#installing-rabbitmq-on-os-x" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id4">Installing RabbitMQ on OS X</a><a class="headerlink" href="#installing-rabbitmq-on-os-x" title="Permalink to this headline">¶</a></h2>
 <p>The easiest way to install RabbitMQ on Snow Leopard is using <a class="reference external" href="http://github.com/mxcl/homebrew/">Homebrew</a>; the new
 and shiny package management system for OS X.</p>
 <p>In this example we&#8217;ll install homebrew into <tt class="docutils literal"><span class="pre">/lol</span></tt>, but you can
@@ -97,7 +108,7 @@ <h2>Installing RabbitMQ on OS X<a class="headerlink" href="#installing-rabbitmq-
 <div class="highlight-python"><pre>$ brew install rabbitmq</pre>
 </div>
 <div class="section" id="configuring-the-system-hostname">
-<h3>Configuring the system hostname<a class="headerlink" href="#configuring-the-system-hostname" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id5">Configuring the system hostname</a><a class="headerlink" href="#configuring-the-system-hostname" title="Permalink to this headline">¶</a></h3>
 <p>If you&#8217;re using a DHCP server that is giving you a random hostname, you need
 to permanently configure the hostname. This is because RabbitMQ uses the hostname
 to communicate with nodes.</p>
@@ -127,7 +138,7 @@ <h3>Configuring the system hostname<a class="headerlink" href="#configuring-the-
 then RabbitMQ will try to use <tt class="docutils literal"><span class="pre">rabbit&#64;23</span></tt>, which is an illegal hostname.</p>
 </div>
 <div class="section" id="starting-stopping-the-rabbitmq-server">
-<h3>Starting/Stopping the RabbitMQ server<a class="headerlink" href="#starting-stopping-the-rabbitmq-server" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id6">Starting/Stopping the RabbitMQ server</a><a class="headerlink" href="#starting-stopping-the-rabbitmq-server" title="Permalink to this headline">¶</a></h3>
 <p>To start the server:</p>
 <div class="highlight-python"><pre>$ sudo rabbitmq-server</pre>
 </div>

cookbook/tasks.html

@@ -54,8 +54,16 @@ <h3>Navigation</h3>
 
   <div class="section" id="first-steps-with-celery">
 <h1>First steps with Celery<a class="headerlink" href="#first-steps-with-celery" title="Permalink to this headline">¶</a></h1>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference external" href="#creating-a-simple-task" id="id1">Creating a simple task</a></li>
+<li><a class="reference external" href="#configuration" id="id2">Configuration</a></li>
+<li><a class="reference external" href="#running-the-celery-worker-server" id="id3">Running the celery worker server</a></li>
+<li><a class="reference external" href="#executing-the-task" id="id4">Executing the task</a></li>
+</ul>
+</div>
 <div class="section" id="creating-a-simple-task">
-<h2>Creating a simple task<a class="headerlink" href="#creating-a-simple-task" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id1">Creating a simple task</a><a class="headerlink" href="#creating-a-simple-task" title="Permalink to this headline">¶</a></h2>
 <p>In this example we are creating a simple task that adds two
 numbers. Tasks are defined in a normal python module. The module can
 be named whatever you like, but the convention is to call it
@@ -76,7 +84,7 @@ <h2>Creating a simple task<a class="headerlink" href="#creating-a-simple-task" t
 <a class="reference internal" href="../userguide/tasks.html"><em>Executing Tasks</em></a>.</p>
 </div>
 <div class="section" id="configuration">
-<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id2">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
 <p>Celery is configured by using a configuration module. By convention,
 this module is called <tt class="docutils literal"><span class="pre">celeryconfig.py</span></tt>. This module must be in the
 Python path so it can be imported.</p>
@@ -117,7 +125,7 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
 <a class="reference internal" href="../configuration.html"><em>configuration directive reference</em></a>.</p>
 </div>
 <div class="section" id="running-the-celery-worker-server">
-<h2>Running the celery worker server<a class="headerlink" href="#running-the-celery-worker-server" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id3">Running the celery worker server</a><a class="headerlink" href="#running-the-celery-worker-server" title="Permalink to this headline">¶</a></h2>
 <p>To test we will run the worker server in the foreground, so we can
 see what&#8217;s going on in the terminal:</p>
 <div class="highlight-python"><pre>$ PYTHONPATH="." celeryd --loglevel=INFO</pre>
@@ -133,7 +141,7 @@ <h2>Running the celery worker server<a class="headerlink" href="#running-the-cel
 <a class="reference internal" href="../cookbook/daemonizing.html"><em>daemon mode reference</em></a></p>
 </div>
 <div class="section" id="executing-the-task">
-<h2>Executing the task<a class="headerlink" href="#executing-the-task" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id4">Executing the task</a><a class="headerlink" href="#executing-the-task" title="Permalink to this headline">¶</a></h2>
 <p>Whenever we want to execute our task, we can use the <tt class="docutils literal"><span class="pre">delay</span></tt> method
 of the task class.</p>
 <p>This is a handy shortcut to the <tt class="docutils literal"><span class="pre">apply_async</span></tt> method which gives

faq.html

@@ -58,7 +58,7 @@ <h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
 <tbody valign="top">
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">1.1</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 07, 2010</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 09, 2010</td>
 </tr>
 </tbody>
 </table>
@@ -85,7 +85,12 @@ <h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
 <li class="toctree-l2"><a class="reference internal" href="first-steps-with-celery.html#executing-the-task">Executing the task</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="periodic-tasks.html">Periodic Tasks</a></li>
+<li class="toctree-l1"><a class="reference internal" href="periodic-tasks.html">Periodic Tasks</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="periodic-tasks.html#introduction">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="periodic-tasks.html#crontab-like-schedules">Crontab-like schedules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="periodic-tasks.html#starting-celerybeat">Starting celerybeat</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="resources.html#getting-help">Getting Help</a></li>
 <li class="toctree-l2"><a class="reference internal" href="resources.html#bug-tracker">Bug tracker</a></li>

genindex.html

@@ -85,8 +85,21 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
 databases (<a class="reference external" href="http://www.sqlalchemy.org/">SQLAlchemy</a>) is also available.</p>
 <p>You may also be pleased to know that full Django integration exists
 via the <a class="reference external" href="http://pypi.python.org/pypi/django-celery">django-celery</a> package.</p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference external" href="#overview" id="id1">Overview</a></li>
+<li><a class="reference external" href="#example" id="id2">Example</a></li>
+<li><a class="reference external" href="#features" id="id3">Features</a></li>
+<li><a class="reference external" href="#documentation" id="id4">Documentation</a></li>
+<li><a class="reference external" href="#installation" id="id5">Installation</a><ul>
+<li><a class="reference external" href="#downloading-and-installing-from-source" id="id6">Downloading and installing from source</a></li>
+<li><a class="reference external" href="#using-the-development-version" id="id7">Using the development version</a></li>
+</ul>
+</li>
+</ul>
+</div>
 <div class="section" id="overview">
-<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id1">Overview</a><a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
 <p>This is a high level overview of the architecture.</p>
 <img alt="http://cloud.github.com/downloads/ask/celery/Celery-Overview-v4.jpg" src="http://cloud.github.com/downloads/ask/celery/Celery-Overview-v4.jpg" />
 <p>The broker pushes tasks to the worker servers.
@@ -96,7 +109,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
 &#8220;tombstone&#8221;).</p>
 </div>
 <div class="section" id="example">
-<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id2">Example</a><a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
 <p>You probably want to see some code by now, so here&#8217;s an example task
 adding two numbers:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">celery.decorators</span> <span class="kn">import</span> <span class="n">task</span>
@@ -115,7 +128,7 @@ <h2>Example<a class="headerlink" href="#example" title="Permalink to this headli
 <p>Simple!</p>
 </div>
 <div class="section" id="features">
-<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id3">Features</a><a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <table border="1" class="docutils">
 <colgroup>
@@ -226,12 +239,12 @@ <h2>Features<a class="headerlink" href="#features" title="Permalink to this head
 </blockquote>
 </div>
 <div class="section" id="documentation">
-<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id4">Documentation</a><a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
 <p>The <a class="reference external" href="http://ask.github.com/celery/">latest documentation</a> with user guides, tutorials and API reference
 is hosted at Github.</p>
 </div>
 <div class="section" id="installation">
-<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id5">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
 <p>You can install <tt class="docutils literal"><span class="pre">celery</span></tt> either via the Python Package Index (PyPI)
 or from source.</p>
 <p>To install using <tt class="docutils literal"><span class="pre">pip</span></tt>,:</p>
@@ -241,7 +254,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <div class="highlight-python"><pre>$ easy_install celery</pre>
 </div>
 <div class="section" id="downloading-and-installing-from-source">
-<h3>Downloading and installing from source<a class="headerlink" href="#downloading-and-installing-from-source" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id6">Downloading and installing from source</a><a class="headerlink" href="#downloading-and-installing-from-source" title="Permalink to this headline">¶</a></h3>
 <p>Download the latest version of <tt class="docutils literal"><span class="pre">celery</span></tt> from
 <a class="reference external" href="http://pypi.python.org/pypi/celery/">http://pypi.python.org/pypi/celery/</a></p>
 <p>You can install it by doing the following,:</p>
@@ -252,7 +265,7 @@ <h3>Downloading and installing from source<a class="headerlink" href="#downloadi
 </div>
 </div>
 <div class="section" id="using-the-development-version">
-<h3>Using the development version<a class="headerlink" href="#using-the-development-version" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id7">Using the development version</a><a class="headerlink" href="#using-the-development-version" title="Permalink to this headline">¶</a></h3>
 <p>You can clone the repository by doing the following:</p>
 <div class="highlight-python"><pre>$ git clone git://github.com/ask/celery.git</pre>
 </div>