Permalink
Browse files

Minor doc tweaks

  • Loading branch information...
1 parent a14e1ba commit 72c0b37a4636b14a7746d7856d5a1f82f177f396 @davedash davedash committed Aug 11, 2011
Showing with 21 additions and 3 deletions.
  1. +1 −0 .gitignore
  2. +8 −0 docs/installation.rst
  3. +12 −3 docs/queries.rst
View
@@ -1,3 +1,4 @@
build/
dist/
*.egg-info
+docs/_build/
View
@@ -22,6 +22,14 @@ Installation
so you don't have to
have ElasticSearch running.
+.. data:: ES_DUMP_CURL
+
+ If set to a path all the requests that `ElasticUtils` makes will be dumped
+ into the designated file.
+
+ .. note:: Python does not write this file until the process is finished.
+
+
.. data:: ES_HOSTS
This is a list of hosts. In development this will look like::
View
@@ -6,9 +6,18 @@ ElasticUtils makes querying and filtering and collecting facets from
ElasticSearch simple ::
- q = (S(product='firefox').filter(version='4.0', platform='all')
- .facet('product', global_=True).facet('version')
- .facet('platform').facet('type'))
+ q = (S(model).filter(product='firefox')
+ .filter(version='4.0', platform='all')
+ .facet('product', global_=True).facet('version')
+ .facet('platform').facet('type'))
+
+
+Where ``model`` is a Django-model.
+
+.. note::
+
+ If you're not using Django, you can create stub-models. See the tests for
+ more details.
Search All
----------

0 comments on commit 72c0b37

Please sign in to comment.