From 77ad11d1d08c783e36bde86bcbd780eaf1e4e551 Mon Sep 17 00:00:00 2001 From: Wes Turner Date: Sat, 28 May 2016 13:50:16 -0500 Subject: [PATCH 1/3] DOC: README.rst: links, refs --- README.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 656fba1..16fccbb 100644 --- a/README.rst +++ b/README.rst @@ -6,22 +6,31 @@ celery-haystack :alt: Build Status :target: http://travis-ci.org/django-haystack/celery-haystack +| Src: https://github.com/django-haystack/celery-haystack +| PyPI: https://pypi.python.org/pypi/celery-haystack +| Docs: https://celery-haystack.readthedocs.io/en/latest/ + This Django app allows you to utilize Celery for automatically updating and deleting objects in a Haystack_ search index. + Requirements ------------ -* Django 1.8+ -* Haystack_ `2.X`_ -* Celery_ 3.X +* Django_ `1.8+`_ +* Haystack_ 2.X_ +* Celery_ 3.X_ You also need to install your choice of one of the supported search engines for Haystack and one of the supported backends for Celery. -.. _Haystack: http://haystacksearch.org -.. _Celery: http://www.celeryproject.org +.. _Django: https://www.djangoproject.com/ +.. _1.8+: https://github.com/django/django +.. _Haystack: http://haystacksearch.org/ +.. _2.X: https://github.com/django-haystack/django-haystack +.. _Celery: http://www.celeryproject.org/ +.. _3.X: https://github.com/celery/celery Installation @@ -82,7 +91,6 @@ app but uses Ask Solem Hoel's Celery_ instead of the equally awesome queues_ library by Matt Croyden. .. _queued_search: https://github.com/toastdriven/queued_search/ -.. _Celery: http://celeryproject.org/ .. _queues: http://code.google.com/p/queues/ Issues From dfafc71e3fe81b3213d6ce9650bdcdd53894a75e Mon Sep 17 00:00:00 2001 From: Wes Turner Date: Sat, 28 May 2016 13:52:11 -0500 Subject: [PATCH 2/3] DOC: README.rst: description, src, docs, pypi --- README.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 16fccbb..735acf6 100644 --- a/README.rst +++ b/README.rst @@ -6,14 +6,15 @@ celery-haystack :alt: Build Status :target: http://travis-ci.org/django-haystack/celery-haystack -| Src: https://github.com/django-haystack/celery-haystack -| PyPI: https://pypi.python.org/pypi/celery-haystack -| Docs: https://celery-haystack.readthedocs.io/en/latest/ This Django app allows you to utilize Celery for automatically updating and deleting objects in a Haystack_ search index. +| Src: https://github.com/django-haystack/celery-haystack +| Docs: https://celery-haystack.readthedocs.io/en/latest/ +| PyPI: https://pypi.python.org/pypi/celery-haystack + Requirements ------------ From 61a46abfdb27aa91a4cd4d78aef3c4afc1084ffd Mon Sep 17 00:00:00 2001 From: Wes Turner Date: Sat, 28 May 2016 13:59:30 -0500 Subject: [PATCH 3/3] DOC: README.rst: links to Haystack & Celery docs --- README.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 735acf6..2ece147 100644 --- a/README.rst +++ b/README.rst @@ -23,8 +23,13 @@ Requirements * Celery_ 3.X_ You also need to install your choice of one of the supported search engines -for Haystack and one of the supported backends for Celery. +for Haystack and one of the supported backends for Celery: +* https://django-haystack.readthedocs.io/en/latest/backend_support.html#backend-support-matrix +* https://django-haystack.readthedocs.io/en/latest/installing_search_engines.html +* https://django-haystack.readthedocs.io/en/latest/settings.html +* http://docs.celeryproject.org/en/latest/getting-started/brokers/#broker-overview +* http://docs.celeryproject.org/en/latest/configuration.html .. _Django: https://www.djangoproject.com/ .. _1.8+: https://github.com/django/django