Browse Source

Autogenerated documentation for github.

Ask Solem 15 years ago
parent
commit
93dd7110dd
5 changed files with 33 additions and 2 deletions
  1. 15 0
      faq.html
  2. 1 1
      reference/celery.fields.html
  3. 1 1
      reference/celery.utils.html
  4. 0 0
      searchindex.js
  5. 16 0
      sources/faq.txt

+ 15 - 0
faq.html

@@ -271,6 +271,21 @@ executed. Currently there are two loaders, the default loader and the Django
 loader. If you want to use celery without a Django project, you either have to
 use the default loader, or a write a loader of your own.</p>
 <p>The rest of this answer describes how to use the default loader.</p>
+<p>First of all, installation. You need to get the development version of
+celery from github:</p>
+<div class="highlight-python"><pre>$ git clone git://github.com/ask/celery.git
+$ cd celery
+# python setup.py install # as root</pre>
+</div>
+<p>While it is possible to use celery from outside of Django, we still need
+Django itself to run, this is to use the ORM and cache-framework, etc.
+Duplicating these features would be time consuming and mostly pointless, so
+we decided that having a dependency on Django itself was a good thing.
+Install Django using your favorite install tool, <tt class="docutils literal"><span class="pre">easy_install</span></tt>, <tt class="docutils literal"><span class="pre">pip</span></tt>, or
+whatever:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="c"># easy_install django # as root</span>
+</pre></div>
+</div>
 <p>You need a configuration file named <tt class="docutils literal"><span class="pre">celeryconfig.py</span></tt>, either in the
 directory you run <tt class="docutils literal"><span class="pre">celeryd</span></tt> in, or in a Python library path where it is
 able to find it. The configuration file can contain any of the settings

+ 1 - 1
reference/celery.fields.html

@@ -64,7 +64,7 @@ then it must [well, should] be a pickled one).</dd></dl>
 <dl class="class">
 <dt id="celery.fields.PickledObjectField">
 <em class="property">
-class </em><tt class="descclassname">celery.fields.</tt><tt class="descname">PickledObjectField</tt><big>(</big><em>verbose_name=None</em>, <em>name=None</em>, <em>primary_key=False</em>, <em>max_length=None</em>, <em>unique=False</em>, <em>blank=False</em>, <em>null=False</em>, <em>db_index=False</em>, <em>rel=None</em>, <em>default=&lt;class django.db.models.fields.NOT_PROVIDED at 0x2162ed0&gt;</em>, <em>editable=True</em>, <em>serialize=True</em>, <em>unique_for_date=None</em>, <em>unique_for_month=None</em>, <em>unique_for_year=None</em>, <em>choices=None</em>, <em>help_text=''</em>, <em>db_column=None</em>, <em>db_tablespace=None</em>, <em>auto_created=False</em><big>)</big><a class="headerlink" href="#celery.fields.PickledObjectField" title="Permalink to this definition">¶</a></dt>
+class </em><tt class="descclassname">celery.fields.</tt><tt class="descname">PickledObjectField</tt><big>(</big><em>verbose_name=None</em>, <em>name=None</em>, <em>primary_key=False</em>, <em>max_length=None</em>, <em>unique=False</em>, <em>blank=False</em>, <em>null=False</em>, <em>db_index=False</em>, <em>rel=None</em>, <em>default=&lt;class django.db.models.fields.NOT_PROVIDED at 0x2165f00&gt;</em>, <em>editable=True</em>, <em>serialize=True</em>, <em>unique_for_date=None</em>, <em>unique_for_month=None</em>, <em>unique_for_year=None</em>, <em>choices=None</em>, <em>help_text=''</em>, <em>db_column=None</em>, <em>db_tablespace=None</em>, <em>auto_created=False</em><big>)</big><a class="headerlink" href="#celery.fields.PickledObjectField" title="Permalink to this definition">¶</a></dt>
 <dd><p>A field that automatically pickles/unpickles its value.</p>
 <dl class="method">
 <dt id="celery.fields.PickledObjectField.get_db_prep_lookup">

+ 1 - 1
reference/celery.utils.html

@@ -97,7 +97,7 @@ yield the last value infinitely.</dd></dl>
 
 <dl class="function">
 <dt id="celery.utils.retry_over_time">
-<tt class="descclassname">celery.utils.</tt><tt class="descname">retry_over_time</tt><big>(</big><em>fun</em>, <em>catch</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>kwargs={}</em>, <em>errback=&lt;function &lt;lambda&gt; at 0x21c4a70&gt;</em>, <em>max_retries=None</em>, <em>interval_start=2</em>, <em>interval_step=2</em>, <em>interval_max=30</em><big>)</big><a class="headerlink" href="#celery.utils.retry_over_time" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">celery.utils.</tt><tt class="descname">retry_over_time</tt><big>(</big><em>fun</em>, <em>catch</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>kwargs={}</em>, <em>errback=&lt;function &lt;lambda&gt; at 0x21c6ab0&gt;</em>, <em>max_retries=None</em>, <em>interval_start=2</em>, <em>interval_step=2</em>, <em>interval_max=30</em><big>)</big><a class="headerlink" href="#celery.utils.retry_over_time" title="Permalink to this definition">¶</a></dt>
 <dd><p>Retry the function over and over until max retries is exceeded.</p>
 <p>For each retry we sleep a for a while before we try again, this interval
 is increased for every retry until the max seconds is reached.</p>

File diff suppressed because it is too large
+ 0 - 0
searchindex.js


+ 16 - 0
sources/faq.txt

@@ -257,6 +257,22 @@ use the default loader, or a write a loader of your own.
 
 The rest of this answer describes how to use the default loader.
 
+First of all, installation. You need to get the development version of
+celery from github::
+
+    $ git clone git://github.com/ask/celery.git
+    $ cd celery
+    # python setup.py install # as root
+
+While it is possible to use celery from outside of Django, we still need
+Django itself to run, this is to use the ORM and cache-framework, etc.
+Duplicating these features would be time consuming and mostly pointless, so
+we decided that having a dependency on Django itself was a good thing.
+Install Django using your favorite install tool, ``easy_install``, ``pip``, or
+whatever::
+
+    # easy_install django # as root
+
 You need a configuration file named ``celeryconfig.py``, either in the
 directory you run ``celeryd`` in, or in a Python library path where it is
 able to find it. The configuration file can contain any of the settings

Some files were not shown because too many files changed in this diff