Permalink
Browse files

Refactored documentation to format better in Sphinx.

  • Loading branch information...
1 parent 8a00b89 commit 35f257c25cace9a353ca7805025bda1a886380fd @mcroydon mcroydon committed with toastdriven Jan 28, 2009
View
@@ -2,4 +2,3 @@
.DS_Store
results_soc.py
results_old.py
-_build
View
No changes.
View
No changes.
No changes.
View
@@ -6,16 +6,14 @@ Backend Support
Supported Backends
==================
- * Solr_
- * Lucene_
- * CouchDB_
- * Xapian_
- * `Hyper Estraier`_
- * Sphinx_
+* Solr_
+* Lucene_
+* Xapian_
+* `Hyper Estraier`_
+* Sphinx_
.. _Solr: http://lucene.apache.org/solr/
.. _Lucene: http://lucene.apache.org/java/
-.. _CouchDB: http://couchdb.apache.org/
.. _Xapian: http://xapian.org/
.. _Hyper Estraier: http://hyperestraier.sourceforge.net/
.. _Sphinx: http://www.sphinxsearch.com/
@@ -27,49 +25,49 @@ Backend Capabilities
Solr
----
- * Full SearchQuerySet support
- * Automatic query building
- * "More Like This" functionality
- * Term Boosting
- * Faceting
- * Stored (non-indexed) fields
- * Requires: pysolr
+* Full SearchQuerySet support
+* Automatic query building
+* "More Like This" functionality
+* Term Boosting
+* Faceting
+* Stored (non-indexed) fields
+* Requires: pysolr
Lucene
------
- * Full SearchQuerySet support
- * Automatic query building
- * Term Boosting
- * Stored (non-indexed) fields
- * Requires: pyluncene (owwie?)
+* Full SearchQuerySet support
+* Automatic query building
+* Term Boosting
+* Stored (non-indexed) fields
+* Requires: pyluncene (owwie?)
Xapian
------
- * Full SearchQuerySet support
- * Automatic query building
- * "More Like This" functionality
- * Faceting
- * Stored (non-indexed) fields
- * Requires: xappy?
+* Full SearchQuerySet support
+* Automatic query building
+* "More Like This" functionality
+* Faceting
+* Stored (non-indexed) fields
+* Requires: xappy?
Hyper Estraier
--------------
- * Full SearchQuerySet support
- * Automatic query building
- * "More Like This" functionality
- * Requires: SWIG bindings
+* Full SearchQuerySet support
+* Automatic query building
+* "More Like This" functionality
+* Requires: SWIG bindings
Sphinx
------
- * Full SearchQuerySet support
- * Automatic query building
- * Term Boosting
- * Stored (non-indexed) fields
- * Requires: sphinxapi.py (Comes with Sphinx)
+* Full SearchQuerySet support
+* Automatic query building
+* Term Boosting
+* Stored (non-indexed) fields
+* Requires: sphinxapi.py (Comes with Sphinx)
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+
@@ -84,6 +82,4 @@ Sphinx
| Hyper Estraier | Yes | Yes | Yes | No | No | No |
+----------------+------------------------+---------------------+----------------+------------+----------+---------------+
| Sphinx | Yes | Yes | No | Yes | No | Yes |
-+================+========================+=====================+================+============+==========+===============+
-
-
++----------------+------------------------+---------------------+----------------+------------+----------+---------------+
@@ -4,10 +4,11 @@ Creating New Backends
The process should be fairly simple.
- # Create new backend file. Name is important.
- # Two classes inside.
- # SearchBackend
- # SearchQuery
+#. Create new backend file. Name is important.
+#. Two classes inside.
+
+ #. SearchBackend
+ #. SearchQuery
SearchBackend
@@ -16,12 +17,13 @@ SearchBackend
Responsible for the actual connection and low-level details of interacting with
the backend.
- * Connects to search engine
- * Method for saving new docs to index
- * Method for removing docs from index
- * Method for performing the actual query
- * Returns SearchResult objects
- * Must populate a hit count if provided by backend
+* Connects to search engine
+* Method for saving new docs to index
+* Method for removing docs from index
+* Method for performing the actual query
+
+ * Returns SearchResult objects
+ * Must populate a hit count if provided by backend
SearchQuery
@@ -30,6 +32,6 @@ SearchQuery
Responsible for taking structured data about the query and converting it into a
backend appropriate format.
- * Method for creating the backend specific query - build_query
- * Method for returning hits - get_count
- * Method for sanitizing user queries - clean
+* Method for creating the backend specific query - build_query
+* Method for returning hits - get_count
+* Method for sanitizing user queries - clean
View
@@ -6,34 +6,22 @@ SearchQuerySet
One main implementation.
- * Standard API that loosely follows QuerySet
- * Handles most queries
- * Allows for custom "parsing"/building through API
- * Dispatches to backend for actual query
- * Handles automatically creating a query
-
+* Standard API that loosely follows QuerySet
+* Handles most queries
+* Allows for custom "parsing"/building through API
+* Dispatches to backend for actual query
+* Handles automatically creating a query
SearchBackend
-------------
Implemented per-backend.
- * Connects to search engine
- * Method for saving new docs to index
- * Method for removing docs from index
- * Method for performing the actual query
- * What does this return? SearchResult objects? A list of dicts?
- * What about the total count?
+* Connects to search engine
+* Method for saving new docs to index
+* Method for removing docs from index
+* Method for performing the actual query
-
-Questions
----------
-
- * Should there be a SearchQuery object, implemented on a per-backend basis,
- that handles generating the actual query? Or should the SearchBackend
- simply provide a build_query method that accepts the all the details from
- SearchQuerySet and constructs the query?
- * How will automagic queries work? Backend-specific or use the
- SearchQuerySet API to just build it and let it process through the backend
- the same way as manual queries?
+ * What does this return? SearchResult objects? A list of dicts?
+ * What about the total count?

0 comments on commit 35f257c

Please sign in to comment.