Browse Source

[docs] Fixes doc build errors

Ask Solem 9 years ago
parent
commit
e191afe7f8

+ 4 - 8
docs/glossary.rst

@@ -18,8 +18,7 @@ Glossary
     ack
     ack
         Short for :term:`acknowledged`.
         Short for :term:`acknowledged`.
 
 
-    early acknowledgement
-
+    early acknowledgment
         Task is :term:`acknowledged` just-in-time before being executed,
         Task is :term:`acknowledged` just-in-time before being executed,
         meaning the task will not be redelivered to another worker if the
         meaning the task will not be redelivered to another worker if the
         machine loses power, or the worker instance is abruptly killed,
         machine loses power, or the worker instance is abruptly killed,
@@ -28,7 +27,6 @@ Glossary
         Configured using :setting:`task_acks_late`.
         Configured using :setting:`task_acks_late`.
 
 
     late acknowledgment
     late acknowledgment
-
         Task is :term:`acknowledged` after execution (both if successful, or
         Task is :term:`acknowledged` after execution (both if successful, or
         if the task is raising an error), which means the task will be
         if the task is raising an error), which means the task will be
         redelivered to another worker in the event of the machine losing
         redelivered to another worker in the event of the machine losing
@@ -37,12 +35,10 @@ Glossary
         Configured using :setting:`task_acks_late`.
         Configured using :setting:`task_acks_late`.
 
 
     early ack
     early ack
-
-        Short for :term:`early acknowledgement`
+        Short for :term:`early acknowledgment`
 
 
     late ack
     late ack
-
-        Short for :term:`late acknowledgement`
+        Short for :term:`late acknowledgment`
 
 
     request
     request
         Task messages are converted to *requests* within the worker.
         Task messages are converted to *requests* within the worker.
@@ -105,7 +101,7 @@ Glossary
         :setting:`worker_prefetch_multiplier` setting, which is multiplied
         :setting:`worker_prefetch_multiplier` setting, which is multiplied
         by the number of pool slots (threads/processes/greenthreads).
         by the number of pool slots (threads/processes/greenthreads).
 
 
-    prefetch count
+    `prefetch count`
         Maximum number of unacknowledged messages a consumer can hold and if
         Maximum number of unacknowledged messages a consumer can hold and if
         exceeded the transport should not deliver any more messages to that
         exceeded the transport should not deliver any more messages to that
         consumer.  See :ref:`optimizing-prefetch-limit`.
         consumer.  See :ref:`optimizing-prefetch-limit`.

+ 1 - 1
docs/history/changelog-3.1.rst

@@ -87,7 +87,7 @@ new in Celery 3.1.
 
 
 - **Worker**: Bootsteps can now hook into ``on_node_join``/``leave``/``lost``.
 - **Worker**: Bootsteps can now hook into ``on_node_join``/``leave``/``lost``.
 
 
-    See :ref:`extending-consumer-gossip` for an example.
+    See :ref:`extending-consumer-attributes` for an example.
 
 
 - **Events**: Fixed handling of DST timezones (Issue #2983).
 - **Events**: Fixed handling of DST timezones (Issue #2983).
 
 

+ 0 - 0
docs/internals/reference/celery.backends.elasticsearch.txt → docs/internals/reference/celery.backends.elasticsearch.rst


+ 1 - 1
docs/userguide/optimizing.rst

@@ -191,7 +191,7 @@ they really mean by that is to have a worker only reserve as many tasks as
 there are worker processes (10 unacknowledged tasks for `-c 10`)
 there are worker processes (10 unacknowledged tasks for `-c 10`)
 
 
 That is possible, but not without also enabling
 That is possible, but not without also enabling
-:term:`late acknowledgments`.  Using this option over the
+:term:`late acknowledgment`.  Using this option over the
 default beahvior means a task that has already started executing will be
 default beahvior means a task that has already started executing will be
 retried in the event of a power failure or the worker instance being killed
 retried in the event of a power failure or the worker instance being killed
 abruptly, so this also means the task must be :term:`idempotent`
 abruptly, so this also means the task must be :term:`idempotent`

+ 15 - 15
docs/whatsnew-4.0.rst

@@ -258,19 +258,19 @@ the intent of the required connection.
 
 
 .. note::
 .. note::
 
 
-Two connection pools are available: ``app.pool`` (read), and
-``app.producer_pool`` (write).  The latter does not actually give connections
-but full :class:`kombu.Producer` instances.
+    Two connection pools are available: ``app.pool`` (read), and
+    ``app.producer_pool`` (write).  The latter does not actually give connections
+    but full :class:`kombu.Producer` instances.
 
 
-.. code-block:: python
+    .. code-block:: python
 
 
-    def publish_some_message(app, producer=None):
-        with app.producer_or_acquire(producer) as producer:
-            ...
+        def publish_some_message(app, producer=None):
+            with app.producer_or_acquire(producer) as producer:
+                ...
 
 
-    def consume_messages(app, connection=None):
-        with app.connection_or_acquire(connection) as connection:
-            ...
+        def consume_messages(app, connection=None):
+            with app.connection_or_acquire(connection) as connection:
+                ...
 
 
 Canvas Refactor
 Canvas Refactor
 ===============
 ===============
@@ -467,9 +467,9 @@ In Other News
 
 
 - **Requirements**:
 - **Requirements**:
 
 
-    - Now depends on :ref:`Kombu 3.1 <kombu:version-3.1.0>`.
+    - Now depends on :ref:`Kombu 4.0 <kombu:version-4.0>`.
 
 
-    - Now depends on :mod:`billiard` version 3.4.
+    - Now depends on :mod:`billiard` version 3.5.
 
 
     - No longer depends on ``anyjson`` :sadface:
     - No longer depends on ``anyjson`` :sadface:
 
 
@@ -480,7 +480,7 @@ In Other News
   in addition it also improves reliability for the Redis broker transport.
   in addition it also improves reliability for the Redis broker transport.
 
 
 - **Eventlet/Gevent**: Fixed race condition leading to "simultaneous read"
 - **Eventlet/Gevent**: Fixed race condition leading to "simultaneous read"
- errors (Issue #2812).
+  errors (Issue #2812).
 
 
 - **Programs**: ``%n`` format for :program:`celery multi` is now synonym with
 - **Programs**: ``%n`` format for :program:`celery multi` is now synonym with
   ``%N`` to be consistent with :program:`celery worker`.
   ``%N`` to be consistent with :program:`celery worker`.
@@ -626,7 +626,7 @@ In Other News
   file formats.
   file formats.
 
 
 - **Programs**: ``%p`` can now be used to expand to the full worker nodename
 - **Programs**: ``%p`` can now be used to expand to the full worker nodename
- in logfile/pidfile arguments.
+  in logfile/pidfile arguments.
 
 
 - **Programs**: A new command line option :option:``--executable`` is now
 - **Programs**: A new command line option :option:``--executable`` is now
   available for daemonizing programs.
   available for daemonizing programs.
@@ -640,7 +640,7 @@ In Other News
 
 
 - **Deployment**: Generic init scripts now support
 - **Deployment**: Generic init scripts now support
   :envvar:`CELERY_SU`` and :envvar:`CELERYD_SU_ARGS` environment variables
   :envvar:`CELERY_SU`` and :envvar:`CELERYD_SU_ARGS` environment variables
-  to set the path and arguments for :man:`su(1)`.
+  to set the path and arguments for :manpage:`su(1)`.
 
 
 - **Prefork**: Prefork pool now uses ``poll`` instead of ``select`` where
 - **Prefork**: Prefork pool now uses ``poll`` instead of ``select`` where
   available (Issue #2373).
   available (Issue #2373).