Skip to content

Commit c11cea2

Browse files
committed
docs: update unsupported backends notes
* Officially suggest developing backends as separate projects * Recommend Sphinx users consider django-sphinxql
1 parent d34411a commit c11cea2

File tree

1 file changed

+11
-24
lines changed

1 file changed

+11
-24
lines changed

docs/backend_support.rst

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -96,32 +96,19 @@ Backend Support Matrix
9696
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+--------------+---------+
9797

9898

99-
Wishlist
100-
========
101-
102-
The following are search backends that would be nice to have in Haystack but are
103-
licensed in a way that prevents them from being officially bundled. If the
104-
community expresses interest in any of these, there may be future development.
105-
106-
* Riak_
107-
* Lupyne_
108-
* Sphinx_
109-
110-
.. _Riak: http://www.basho.com/
111-
.. _Lupyne: http://code.google.com/p/lupyne/
112-
.. _Sphinx: http://www.sphinxsearch.com/
99+
Unsupported Backends & Alternatives
100+
===================================
113101

102+
If you have a search engine which you would like to see supported in Haystack, the current recommendation is
103+
to develop a plugin following the lead of `xapian-haystack <https://pypi.python.org/pypi/xapian-haystack>`_ so
104+
that project can be developed and tested independently of the core Haystack release schedule.
114105

115106
Sphinx
116-
------
107+
~~~~~~
117108

118-
This backend is unlikely to be built. Sphinx is pretty gimpy & doesn't do
119-
blended search results across all models the way the other engines can.
120-
Very limited featureset as well.
109+
This backend has been requested multiple times over the years but does not yet have a volunteer maintainer. If
110+
you would like to work on it, please contact the Haystack maintainers so your project can be linked here and,
111+
if desired, added to the `django-haystack <https://github.com/django-haystack/>`_ organization on GitHub.
121112

122-
* Full SearchQuerySet support
123-
* Automatic query building
124-
* Term Boosting
125-
* Stored (non-indexed) fields
126-
* Highlighting
127-
* Requires: sphinxapi.py (Comes with Sphinx)
113+
In the meantime, Sphinx users should consider Jorge C. Leitão's
114+
`django-sphinxql <https://github.com/jorgecarleitao/django-sphinxql>`_ project.

0 commit comments

Comments
 (0)