diff --git a/docs/configure.rst b/docs/configure.rst
index 149fb12..66136f4 100644
--- a/docs/configure.rst
+++ b/docs/configure.rst
@@ -357,7 +357,7 @@ Defaults to ``True``
error_reporter
~~~~~~~~~~~~~~
-You can redirect worker exceptions directly to various error reportes (for example, `Rollbar ` or `Sentry `) by installing Django Q with the necessary `extras `.
+You can redirect worker exceptions directly to various error reporters (for example `Rollbar `__ or `Sentry `__) by installing Django Q with the necessary `extras `__.
To enable installed error reporters, you must provide the configuration settings required by an error reporter extension::
@@ -368,7 +368,7 @@ To enable installed error reporters, you must provide the configuration settings
'access_token': '32we33a92a5224jiww8982',
'environment': 'Django-Q'
}
- }
+ }
}
For more information on error reporters and developing error reporting plugins for Django Q, see :doc:`errors`.
diff --git a/docs/errors.rst b/docs/errors.rst
index 94643e2..dd95eec 100644
--- a/docs/errors.rst
+++ b/docs/errors.rst
@@ -1,9 +1,9 @@
Errors
------
-.. py:currentmodule:: django_q
+.. py:currentmodule:: django_q
-Django Q uses a pluggable error reporter system based upon python `extras `, allowing anyone to develop plugins for error reporting and monitoring integration. Currently implemented examples include `Rollbar ` and `Sentry `).
+Django Q uses a pluggable error reporter system based upon python `extras `__, allowing anyone to develop plugins for their favorite error reporting and monitoring integration. Currently implemented examples include `Rollbar `__ and `Sentry `__.
-Error reporting plugins register a class which implements a ``report`` method, which is invoked when a Django Q cluster encounters an error, pasing information to the particular service. Error reporters must be :ref:`configured` via the ``Q_CLUSTER`` dictionary in your :file:`settings.py`. These settings are passed as kwargs upon initiation of the Error Reporter. Therefore, in order to implement a new plugin, a package must expose a class which will be instantiated with the necessary information via the ``Q_CLUSTER`` settings and implements a single ``report`` method.
+Error reporting plugins register a class which implements a ``report`` method, which is invoked when a Django Q cluster encounters an error, passing information to the particular service. Error reporters must be :ref:`configured` via the ``Q_CLUSTER`` dictionary in your :file:`settings.py`. These settings are passed as kwargs upon initiation of the Error Reporter. Therefore, in order to implement a new plugin, a package must expose a class which will be instantiated with the necessary information via the ``Q_CLUSTER`` settings and implements a single ``report`` method.
-For example implementations, see `django-q-rollbar ` and `django-q-sentry `
+For example implementations, see `django-q-rollbar `__ and `django-q-sentry `__
diff --git a/docs/install.rst b/docs/install.rst
index a590b27..9f4621f 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -86,6 +86,16 @@ Optional
$ pip install rollbar
+
+Extras
+------
+- `django-q-rollbar `__ is a Rollbar error reporter::
+
+ $ pip install django-q[rollbar]
+- `django-q-sentry `__ is a Sentry error reporter::
+
+ $ pip install django-q[sentry]
+
Compatibility
-------------
Django Q is still a young project. If you do find any incompatibilities please submit an issue on `github `__.
@@ -128,7 +138,7 @@ You can reference the `requirements